docs(mermaid,highlighting): Responsive diagrams, shared lexer#96
Merged
Conversation
tony
force-pushed
the
mermaid-improvements
branch
from
f0d9214 to
403c597
Compare
why: The event-stream architecture chart was too wide for narrow docs layouts, and the docs branch needs the responsive Mermaid directive from the gp-sphinx improvement branch. what: - Split the architecture chart into producer and consumer diagrams - Add alt text, stable names, and explicit responsive policy to diagrams
tony
force-pushed
the
mermaid-improvements
branch
from
0c8f451 to
46cad1c
Compare
why: The mermaid-improvements branch should exercise the shared gp-sphinx highlighting package against real agentgrep documentation before it is released. what: - Enable safe inline agentgrep command and path highlighting - Render the accelerator module layout with the tree lexer
tony
force-pushed
the
mermaid-improvements
branch
from
46cad1c to
692ece8
Compare
tony
changed the title
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
1 participant
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.
DO NOT MERGE
This branch temporarily publishes preview documentation from
mermaid-improvementsso responsive Mermaid rendering can be validated on the hosted docs site.This depends on git-pull/gp-sphinx#64. Before merging a final agentgrep docs change, drop the temporary workflow commit and replace the git dependency with the released
sphinx-gp-mermaidversion.Summary
:alt:, stable:name:, and explicit:responsive: fitoptions to the event-stream Mermaid blocks.sphinx-gp-mermaidat the gp-sphinxmermaid-improvementsbranch for preview builds.Verification
rm -rf docs/_build; uv run ruff check . --fix --show-fixes; uv run ruff format .; uv run ty check; uv run py.test --reruns 0 -vvv; just build-docs;28744970352completed successfully: built docs, synced S3, invalidated CloudFront, and purged Cloudflare.https://agentgrep.org/library/event-stream/reports the expected responsive Mermaid markers and stable figure IDs.