docs: deploy documentation site to GitHub Pages#1
Merged
Conversation
Set up an auto-deploying Docusaurus site at https://saldestechnology.github.io/ctx/ and bring its content up to date with v0.2.1. - Add .github/workflows/docs.yml: build docs/website and publish to GitHub Pages via actions/deploy-pages on push to main - Fix docusaurus.config.ts for the project Pages path: url, baseUrl (/ctx/), organizationName, editUrl and GitHub links (were ctx-dev/ctx.dev placeholders); add go/yaml highlighting - Refresh all doc pages to v0.2.1: agentis-ctx install, new --count-only/--max-tokens/--encoding flags, index -j/-p, query graph --output text|json|dot, Go + YAML language support, serve requires --features mcp, audit --incremental not yet done - Publish Commands (audit, diff, smart, shell, serve) and Integrations (ci-cd, claude, vscode) pages with sidebar entries - Remove leftover Docusaurus starter blog and sample page - Add Documentation badge/link to README Verified: npm run build passes with onBrokenLinks: throw (no broken links) and assets resolve under /ctx/.
Add paths-ignore (docs/**, **/*.md) to the CI workflow so pull requests and pushes that only touch documentation don't run the full Rust build/test/lint/publish-dry-run matrix.
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
Stands up an auto-deploying documentation site at https://saldestechnology.github.io/ctx/ and brings its content up to date with v0.2.1.
Previously the Docusaurus site under
docs/website/had never been deployed (no Pages workflow, nogh-pages), its config pointed at placeholder values (ctx.dev/ctx-dev/ctx), and its pages were a stale fork of the top-leveldocs/tree.What's in here
.github/workflows/docs.yml— buildsdocs/websiteand publishes to GitHub Pages viaactions/deploy-pageson push tomain; also build-validates on PRs (deploy is guarded tomainonly).docusaurus.config.tsfor the project Pages path (url,baseUrl: /ctx/,organizationName,editUrl, GitHub links); addedgo/yamlsyntax highlighting; dropped the missing social-card reference.agentis-ctxinstall (binary staysctx), new global flags--count-only/--max-tokens/--encoding,index -j/--parallel&-p/--pattern,query graph --output text|json|dot, Go + YAML language support,serverequires--features mcp,audit --incrementalmarked not-yet-implemented.audit,diff,smart,shell,serve) and Integrations (ci-cd,claude,vscode), wired into the sidebar.Verification
cd docs/website && npm ci && npm run buildpasses withonBrokenLinks: 'throw'(no broken links) and all assets resolve under/ctx/. GitHub Pages has been set to build from GitHub Actions.After merge, the Deploy Docs workflow publishes the site to https://saldestechnology.github.io/ctx/.