Repository navigation
docs: rewrite the README to the Colony layout and sort the docs by reader - #29
Merged
Merged
Conversation
…s of the design-system code
…layout # Conflicts: # README.md # docs/ARCHITECTURE.md # docs/CONFIGURATION.md # docs/DATA_MODEL.md # docs/DEVELOPMENT.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrites the README on the Project Colony program template and re-sorts
docs/by reader. Every page now describesmainas it is after #30 (Colony Preferences page, French, standard Colony folders) and #31 (rustup in CI).README
<picture>(no brand art exists yet; swap inassets/brand/pngwhen it does), a one-sentence tagline, and License / Colonygame/ Platforms badges.> **Status:**: importers are tested against recorded responses only, Steam pages are scraped and the GOG/Epic/PSN endpoints are unofficial, keyring since 0.3.0, ed25519 signing done, Authenticode pending SignPath, and the new UI and folder move still need a desktop check.## Code signing policyis the template text: the.sig/.meta/.meta.sigtable and the OpenSSL 3 check commands with the org public key. The SignPath paragraph stays inside the template's HTML comment, becausesignpath-project-slugis still commented out inrelease.yml.## Privacyis a table of every file Spotter writes (database, preferences, keyring with thecredentials/tokens.jsonfallback, exports and auto-backup, import log, cover and icon cache) and every host it contacts (Steam API, community and store; the127.0.0.1Steam OpenID listener on ports 29876 to 29880; GOG auth, embed and api; the Epic services; xbl.io; ca.account.sony.com; m.np.playstation.com; image CDNs; startup token renewal), with links to each store's privacy policy.~/.local/share/spotterpaths, the "sample library",XDG_DATA_HOMEand--test-threads=1, "credentials in Profile" (they are entered on the Import screen), and the old NPSSO source (nowca.account.sony.com/api/v1/ssocookie).Other files
.gitattributes: the comment# Binariesnow uses a colon instead of a dash, so no em or en dash is left anywhere in the repository.SECURITY.md: private reporting through GitHub Security Advisories, latest release supported, and a scope covering credentials, the Steam login listener, untrusted store and backup input, and release signing.env.exampledeleted: the code reads none of those variables.docs/README.md: a new index sorted by reader, with one line per page saying what it answers.guide/andinternals/:guide/configuration.md,guide/platform-setup.md(from the README's Platform Setup),internals/architecture.md,internals/data-model.md,internals/api-integrations.md,internals/development.md. The README's Testing, Project Structure and Data Storage sections moved intointernals/. The old upper-case pages are deleted; the corrections feat: add French, the Colony Preferences page and shared themes, and move Spotter's files to the standard Colony folders #30 made to them are carried into the new pages.Corrections inside the pages (checked against the code)
remember_filtersdefaults to on).Esccloses the page. Language followsLC_ALL,LC_MESSAGES, thenLANG. The text scale range is 0.7225x to 1.68x. The 0.3 upgrade table maps Dark/Darker/Midnight, the old accents andui_scaleto the shared theme, accent and text size.preferences.rs,paths.rsandi18n/in the module map; colours fromPaletteroles andtheme::shared_accentwithPlatform::accent_key/GameStatus::accent_key(notapp_tint); text throughtheme::ui_textandcolony_ui::sz;effects_enabled()is off with Animations off or reduced motion; the import merge rule (store details overwritten when present, larger playtime kept, status/rating/notes/last played never touched);dirsin the dependency table.GameBuilderdoes not exist; the achievements table hasplatform_id;user_profilehas the Epic and XUID columns; preferences live inpreferences.json(version 2); the<data>/.migrated-from-0.3marker and the fallback to the old files when the copy fails.authz/v3,trophy/v1/trophyTitlesandgamelist/v2(not GraphQL); Xbox also calls account, achievements, x360 and marketplace; GOG lists games withgetFilteredProductsfrom a pasted redirect URL; the Epic account import was missing; the client secret was removed from the page.tests/integration_tests.rsand the#[cfg(test)]modules are described, no "expected dead_code warnings" (CI uses-D warnings), CI runs stable on three OSes then builds and tests on exactly Rust 1.90, and the look and text conventions match the code (ui_text,i18n::t/tf/tn,decimal,percent, the en/fr tests). No mention of a third-party toolchain action.Verification
Merged
mainat 5effd33 (feat: add French, the Colony Preferences page and shared themes, and move Spotter's files to the standard Colony folders #30) into the branch; README conflict resolved to the new README, the four modify/delete conflicts resolved by deleting the old upper-case pages after carrying their feat: add French, the Colony Preferences page and shared themes, and move Spotter's files to the standard Colony folders #30 changes over.Every Preferences label, section, key and default, every Import screen label, every module, function and file path named in the pages was checked against
src/and the colony-ui 0.1.6 labels at 5effd33.The design-system items this PR depended on are confirmed in the merged code: the folder layout in
src/paths.rs(<data>/library/spotter.db,<data>/exports/,<data>/logs/,<cache>/covers,<cache>/achievement_icons,<config>/preferences/preferences.json,<config>/credentials/tokens.jsonwritten owner-only), the copy-only 0.3 migration, the identity button and the General / Appearance / Accessibility / Library / Imports categories, reduced motion skipping the import cascade, thetheme_mode/accent_color/ui_scalemigration insrc/preferences.rs, and no font files left inassets/.Re-checked on the final branch (main unchanged at 5effd33): a script checked every relative link and their
#anchorsin README.md, SECURITY.md and docs/: all resolve.git grep -P '[\x{2013}\x{2014}]'finds no em or en dash in the repository.Docs only: no Rust code changed, so no local cargo run; CI runs as usual.
Re-checked against
mainon the final branch: the--versionexit insrc/main.rs, the Steam listener ports insrc/steam/auth.rs, the 5 MBimport.logrotation insrc/api_client.rs, the sixSortOrdervalues, the folder layout insrc/paths.rs, the four asset names incolony.json, Rust 1.90 inCargo.toml, the Linux package list inci.yml, and that the linked Project-Colony-Resources files and thedesign/releases.md#5-signinganchor exist.