Repository navigation
Bring the software structure docs up to date, with diagrams that fit on GitHub - #137
Merged
Merged
Conversation
…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>
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
docs/development/Software-Structure.mdfor 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).<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.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,GameBananaWeband 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 indocs/README.md.Docs only. Check the diagrams on the PR's rendered view of
Software-Structure.md.🤖 Generated with Claude Code