docs: Material for MkDocs site with GitHub Pages deploy#11
Merged
Conversation
added 4 commits
July 21, 2026 13:04
Add a public documentation website in the style of adk.dev, built with Material for MkDocs and reusing the existing Markdown docs in place. - Marketing homepage (hero, install command, feature cards, before->after demo, benchmark highlight) via a custom home.html override. - ADK-style nav: Get Started, Concepts, Components (overview + 13 per-component pages + DSL engine), How-to Guides, Examples, Benchmarks, Reference, Community. - Native Mermaid diagrams, MathJax for the phi_evict formula, and an interactive Chart.js benchmark chart on the Results page. - Fix components.md drift: document the toon component. - docs.yaml builds with --strict on PRs and deploys Pages from main. Cross-repo links in reused docs rewritten to absolute GitHub URLs so they resolve on the published site. check-yaml runs with --unsafe for mkdocs.yml. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Osher-Elhadad <Osher.Elhadad@ibm.com>
- how-to/use-with-claude-code.md: one-env-var integration, gateway mode, project .claude/settings.json, and verification via /stats. - scripts/with-guru.sh: minimal-effort wrapper that starts the proxy and runs any base-URL-swappable agent through it (e.g. with-guru.sh agent -- claude). - Fix scripts/cc-demo.sh to the current context-guru-proxy interface (the old lab-cx proxy --extract-* flags no longer exist). Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Osher-Elhadad <Osher.Elhadad@ibm.com>
Merge origin/main into the docs branch and run gofmt across the repo — the kagenti->rossoctl module rename string-replaced import paths without re-sorting, leaving the whole tree gofmt-dirty and failing `make lint` on every PR. gofmt re-orders the imports (github.com/maximhq now sorts before github.com/rossoctl). Also retarget the new docs to the moved repo: kagenti/context-guru -> rossoctl/context-guru, the AuthBridge plugin repo -> cortex, and the Pages URL. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Osher-Elhadad <Osher.Elhadad@ibm.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.
What
A public documentation website for context-guru, in the style of adk.dev — built with Material for MkDocs, reusing the existing Markdown docs in place, and deployed to GitHub Pages via a new Actions workflow.
Highlights
overrides/home.html): hero, copyable run command, feature cards for the three guarantees + integration modes, a before→after compaction demo, and a benchmark highlight.phi_evictΦ formula, and an interactive Chart.js benchmark chart on the Results page (real SWE-bench numbers).how-to/use-with-claude-code.md(one-env-var setup) +scripts/with-guru.shhelper; fixed the stalescripts/cc-demo.shto the current proxy interface.tooncomponent (was missing fromcomponents.md)..github/workflows/docs.yamlbuilds withmkdocs build --stricton PRs and deploys Pages frommain; decoupled from the Go CI.Preview locally
Verified
mkdocs build --strictpasses with zero warnings.format+toonviaPOST /compacton the committed sample is byte-identical to the expected output.Notes for merge
deployjob can publish.docs/javascripts/charts.js(marked with aponytail:comment) rather than auto-synced to the results CSV.