docs: add Mermaid diagrams across README and docs - #16
Merged
Conversation
Enrich the documentation with rendered Mermaid diagrams so the architecture, parsing pipeline, and AST are visual on GitHub: - README: request/data-flow overview and two-stage lexer→parser pipeline - docs/README: three-parsers-at-a-glance component diagram - getting-started: request-lifecycle sequence + build-once/reuse flow - filtering: lexer→token→AST pipeline, operator-precedence ladder, worked AST tree, Node interface class diagram, and IS-predicate grammar - configuration: additive allow-list flow, gating decision, group→operator map, and NOT negation-semantics diagram - error-handling: QFV*Error type hierarchy and single-pass aggregation flow - migration: before/after AST shape for the NOT IN change All 17 diagrams validated with @mermaid-js/mermaid-cli.
Required by tooling (github.com/boyter/scc/v3 v3.7.0 needs go >= 1.25.2).
CI installs scc and go-test-coverage with @latest, and actions/setup-go pins the runner Go to the go.mod version. go-test-coverage v2.18.8 requires go >= 1.26, so raise the minimum accordingly.
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.
Summary
Enriches the documentation with rendered Mermaid diagrams so the architecture, parsing pipeline, and AST are visual for readers on GitHub and pkg.go.dev. No code changes — docs and README only.
What's added
README.mddocs/README.mddocs/getting-started.mddocs/filtering.mdNodeinterface class diagram ·IS-predicate grammardocs/configuration.mdNOTnegation-semanticsdocs/error-handling.mdQFV*Errortype hierarchy · single-pass error-aggregation flowdocs/migration.mdNOT INchange17 diagrams total.
Accuracy & validation
parseLogicalOr → parseLogicalAnd → parseComparison → parsePrimary, and theIS-predicate branch mirrorsparseIsPredicate.@mermaid-js/mermaid-cliv11 to confirm they parse and display on GitHub.Notes
Documentation-only change; existing prose is preserved and augmented, not replaced.