Skip to content

Bring the software structure docs up to date, with diagrams that fit on GitHub - #137

Merged
uyujkk merged 1 commit into
mainfrom
claude/docs-structure
Nov 16, 2026
Merged

uyujkk merged 1 commit into
mainfrom
claude/docs-structure

Conversation

@uyujkk

@uyujkk uyujkk commented Nov 16, 2026

Copy link
Copy Markdown
Owner

Rewrites docs/development/Software-Structure.md for main as of 4.8.2 and fixes how its diagrams display on GitHub (node and edge labels were cut off in the old wide bilingual graph).

  • Display: short English node labels with <br/> breaks, a zh/en caption above each diagram, top-to-bottom layouts or subgraph columns, only basic flowchart / sequenceDiagram / stateDiagram-v2 syntax. Rendered locally with mermaid 10.9.1 and 11.4.1: no parse errors, no clipped labels.
  • 15 diagrams: shipped projects; tests and tools; processes; window and pages; page states; services and interfaces; overlay; Core module map; data and who writes it; sequences for deploying a Mod, online download and install, overlay F10 save, overlay slot switch, app update with rollback, and the release pipeline.
  • Content: six pages + AppServices, the transitional host interfaces, page hosting that hides pages (Discord button in What's New, steady Settings groups, faster page switching #135), overlay window/controller, GameBananaWeb and the WebView2 profile, test projects and fixtures, release/Discord/online-sources/CodeQL workflows. Corrects the launcher description.
  • TESTING.md (current UI tests, five test projects, Discord workflow), done notes on the two UI plans, Roadmap (stage J done in 4.8.0), and a "current technical docs" list in docs/README.md.

Docs only. Check the diagrams on the PR's rendered view of Software-Structure.md.

🤖 Generated with Claude Code

…on GitHub

Software-Structure.md describes main as of 4.8.2 instead of 4.7: the six pages and
AppServices from stage J, the services and the IOnlineHost/IWorkspaceHost/IShortcutOverlay
interfaces, page hosting that hides pages instead of removing them (#135), the overlay window
and controller, GameBananaWeb and its WebView2 profile, the test projects (Online.Tests,
UI.Tests and fixtures), and the release, Discord, online-source and CodeQL workflows.

Its diagrams are rebuilt so GitHub shows them whole: short ids, short English labels with
<br/> breaks, top-to-bottom or column layouts with subgraphs, and only basic flowchart,
sequence and state diagrams. There are 15 now: shipped projects, tests and tools, processes,
window and pages, page states, services and interfaces, the overlay, Core modules, data and
who writes it, and sequences for deploying a Mod, an online download, an overlay save, an
overlay slot switch, the app update with rollback and the release pipeline. All render with
mermaid 10.9.1 and 11.4.1, none wider than about 1100 px, no clipped labels.

TESTING.md gains the Discord workflow, the current UI tests (56 methods, 79 cases), the five
test projects and the EndfieldLaunch coverage gate. The UI structure and design plans and the
Roadmap mark stage J as done and keep the plans as history; the docs index lists the current
technical docs first.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@uyujkk
uyujkk merged commit df31bef into main Nov 16, 2026
3 checks passed
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