Fix rendering issues in architecture docs#2861
Merged
michaeldwan merged 4 commits intomainfrom Mar 24, 2026
Merged
Conversation
ASCII art diagrams had bare code fences that some renderers tried to parse as diagrams. Tag them as `text`. Also escape :: in a Mermaid stateDiagram label that was causing parse errors.
Training in its current form is being removed. COG_WEIGHTS is also deprecated. Strip both from the architecture docs rather than adding deprecation noise -- when custom handlers land, the docs get rewritten.
ASCII box-drawing diagrams break when the monospace font has slightly different glyph widths. Mermaid diagrams render cleanly everywhere -- GitHub, mkdocs, VSCode preview.
block-beta with custom fill colors breaks on GitHub dark mode -- white text on pink/grey backgrounds. Switch to plain flowcharts with subgraphs, no custom styles.
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
2 participants
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.
Architecture docs had broken diagrams and documented features that no longer exist.
cog train,train(), Training API) andCOG_WEIGHTS-- training in its current form is going awaystateDiagramparse error caused by unescaped::in a labeltextso renderers don't try to parse them