docs: Add Astro-based documentation site#107
Closed
403-html wants to merge 4 commits into
Closed
Conversation
…<223556219+Copilot@users.noreply.github.com>
…ipts\n\nCo-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…nCo-authored-by: Copilot <223556219+Copilot@users.noreply.github.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
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.
This PR adds an Astro-based documentation site under /docs.\n\nAcceptance checklist:\n- [ ] A1: docs/ package with Astro site committed on branch 'docs/astro-site'\n- [ ] A2: scripts dev/build/preview available; 'pnpm --filter docs dev' and 'pnpm --filter docs build' work\n- [ ] A3: Client-side search with search-index.json (FlexSearch)\n- [ ] A4: Pages: index, getting-started, installation, SDK usage, contributing\n- [ ] A5: Layout: top nav + left sidebar, dark/light toggle, accessible nav and search\n- [ ] A6: Root package.json scripts and .github/workflows/docs.yml added\n- [ ] A7: PR branch 'docs/astro-site' and commits include Co-authored-by trailer\n- [ ] A8: Artifacts: build log, search-index.json, screenshots in docs/artifacts/\n- [ ] A9: docs/README.md with contributor instructions\n\nChanged files: docs/**, .github/workflows/docs.yml, pnpm-workspace.yaml, package.json\n\nBuild verification steps (run locally):\n1) pnpm install\n2) pnpm --filter ./docs dev (to run dev server)\n3) pnpm --filter ./docs build (static build + search-index.json generated)\n\nDeveloper notes:\n- Built a simple Node script to generate search-index.json at build time (docs/scripts/build-search-index.mjs).\n- Search is client-side using FlexSearch and a JSON index.\n- If CI uses different registry or newer tooling, adjust versions in docs/package.json.\n\nCo-authored-by: Copilot 223556219+Copilot@users.noreply.github.com