Add live documentation (DocFX) and complete C4 architecture diagrams#29
Draft
Add live documentation (DocFX) and complete C4 architecture diagrams#29
Conversation
Co-authored-by: fabioravila <7004309+fabioravila@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add documentation and C4 model for system
Add live documentation (DocFX) and complete C4 architecture diagrams
Mar 3, 2026
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.
The project had no documentation beyond a sparse README with a
:TODOplaceholder for API docs and no architectural reference.Documentation site (DocFX)
docfx.json— DocFX config; generates a full browsable site (API reference extracted from XML comments + Markdown pages) via:dotnet tool install -g docfx docfx docfx.json --serve # → http://localhost:8080docs/toc.yml— navigation table-of-contents for DocFXDocs pages
docs/index.md— landing page: overview, quick-start snippet, feature listdocs/getting-started.md— install → load scripts →sortReplies()→reply(); covers topics, object macros, customISessionManager, error handling, fullConfigreferencedocs/api/index.md— API reference index for every public type, grouped by subsystemC4 architecture (all four levels, Mermaid diagrams)
docs/architecture/c4-context.mddocs/architecture/c4-container.mddocs/architecture/c4-component.mddocs/architecture/c4-code.mdclassDiagramblocks for Engine, Parser+AST, TopicManager+Sorting, Session, ObjectHandlers, LoggingREADME
:TODOdocs section with links to the new docs and DocFX serve instructions💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.