Skip to content

Simplify docs into eight canonical files - #707

Merged
aaf2tbz merged 2 commits into
mainfrom
docs/simplify
Oct 5, 2026
Merged

aaf2tbz merged 2 commits into
mainfrom
docs/simplify

Conversation

@aaf2tbz

@aaf2tbz aaf2tbz commented Oct 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

Collapses ~40 first-party docs (~3,100 lines) into 8 files (~1,000 lines) under docs/. Overlapping content is canonicalized (one route table, one launch flow, one ~/.metalsharp layout) and verbose docs are trimmed.

New doc Replaces
docs/README.md docs map
docs/user-guide.md how-to-use-metalsharp, game-streaming
docs/ubisoft-connect.md root Ubisoft Connect Guide.md
docs/emulators.md 4 emulator integration docs
docs/games-supported.md compatibility/GAMES-SUPPORTED.md (same 72 appids)
docs/architecture.md graphics-routes, launch-architecture, all 12 docs/runtime/*, configs/mtsp-roadmap.md, shader-presets/README.md, src/fna/README.md
docs/development.md install-from-source, release-signing, app-gpui/README.md, app/src-c/README.md, .github/hooks/README.md
docs/building-wine.md how-to-build-metalsharp-wine

Removed: finished GPUI port roadmap/feature matrix, app-gpui/HANDOFF.md, PAGE-PARITY.md, SETTINGS-PARITY.md, tools/d3d12-metal-sdk/PR119_WORKSPACE.md. The D3D12 SDK README is cut from 550 to 130 lines. The README itself is unchanged apart from its links.

Path consumers updated

  • app-gpui/src/compat.rs include_str! → docs/games-supported.md (parsed appid set verified identical)
  • tools/ci/check-doc-freshness.py exemption
  • tools/package/create-vendor-trust-kit.sh → copies docs/architecture.md
  • tools/bundles/verify-developer-sdk.sh no longer requires removed SDK docs
  • Route inventory JSON moved to app-gpui/backend-route-inventory.json; inventory-backend-routes.py and gpui-preview.yml updated (--check passes)
  • PR template hook link, AGENTS.md links

Notes

  • Intentionally dropped (still in git history): "remaining work" lists, the SharpEmu release-approval checklist, emulator version/hash pins and scan limits, manual Celeste setup steps.
  • All relative markdown links resolve. The two freshness warnings (README has no Updated: line, no CHANGELOG entry for v0.77.0) already fire on main.
  • Not built locally; cargo test was not run.

Collapse ~40 overlapping docs into docs/: user-guide, ubisoft-connect,
emulators, games-supported, architecture, development, building-wine,
and an index. Remove finished GPUI port planning/handoff notes and the
PR119 workspace note; trim the D3D12 SDK README.

Update consumers of moved paths: compat.rs include_str, doc freshness
exemption, vendor trust kit, SDK verifier, route inventory script and
gpui-preview workflow, PR template hook link, AGENTS.md.
@aaf2tbz
aaf2tbz merged commit 31d144e into main Oct 5, 2026
7 of 8 checks passed
aaf2tbz added a commit that referenced this pull request Oct 14, 2026
Date every release heading (v0.75.0 to v0.79.0, the day each shipped;
v0.79.0 ships after this merges), add the missing v0.77.0 section (the
native GPUI app, #703, and #705), and add what v0.76.0, v0.78.0 and
v0.79.0 were missing: #688, #690, #691, #693, #694, #695, #696, #698,
#699, #700, #706, #707, #708, #709, #723 and the docs work. The AGPL
relicense moves to v0.78.0, the first release that contains it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant