Feature/plugin readiness#115
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new Astro/Starlight documentation site under github-pages/, introduces a fastedge-plugin-source doc-generation pipeline (producing docs/*.md), and expands repo “agent context” documentation. It also reorganizes examples and updates tooling/config to reflect the docs/ → github-pages/ rename, while bumping the required Node version.
Changes:
- Renames/realigns tooling to use
github-pages/for the Astro docs site and updates workspace/tsconfig/jest/docs workflow accordingly. - Adds plugin doc-generation + validation assets under
fastedge-plugin-source/and generated pipeline docs underdocs/. - Adds/updates examples and context documentation, plus introduces workflows for “doctor” and Copilot sync.
Reviewed changes
Copilot reviewed 55 out of 92 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| tsconfig.json | Excludes github-pages/** instead of docs/** from TS compilation. |
| pnpm-workspace.yaml | Switches workspace package from docs to github-pages. |
| package.json | Bumps Node engine to >=22, adds generate:docs, reorders scripts. |
| github-pages/tsconfig.json | Adds Astro strict TS config for the docs site. |
| github-pages/src/test.js | Adds a JS handler file (currently looks like placeholder). |
| github-pages/src/styles/custom.css | Adds sidebar styling overrides. |
| github-pages/src/env.d.ts | Adds Astro env type references. |
| github-pages/src/content/docs/reference/response.md | Adds Response reference page. |
| github-pages/src/content/docs/reference/request.md | Adds Request reference page. |
| github-pages/src/content/docs/reference/overview.md | Adds reference overview page. |
| github-pages/src/content/docs/reference/headers.md | Adds Headers reference page + immutability note. |
| github-pages/src/content/docs/reference/fastedge/secret/get-secret.md | Adds getSecret docs. |
| github-pages/src/content/docs/reference/fastedge/secret/get-secret-effective-at.md | Adds getSecretEffectiveAt docs. |
| github-pages/src/content/docs/reference/fastedge/kv/zset.md | Adds KV sorted set docs. |
| github-pages/src/content/docs/reference/fastedge/kv/open.md | Adds KV open docs. |
| github-pages/src/content/docs/reference/fastedge/kv/key-value.md | Adds KV get/scan docs. |
| github-pages/src/content/docs/reference/fastedge/kv/bloom-filter.md | Adds KV bloom filter docs. |
| github-pages/src/content/docs/reference/fastedge/env/index.md | Adds FastEdge env docs. |
| github-pages/src/content/docs/migrating/v1-v2.md | Adds v1→v2 migration doc. |
| github-pages/src/content/docs/index.mdx | Adds docs landing page. |
| github-pages/src/content/docs/guides/serving-a-static-site.md | Adds guide for static-site compilation workflow. |
| github-pages/src/content/docs/guides/installation.md | Updates install guide Node prerequisite. |
| github-pages/src/content/docs/guides/fastedge.md | Adds product overview guide. |
| github-pages/src/content/docs/guides/fastedge-sdk-js.md | Adds SDK usage guide. |
| github-pages/src/content/docs/guides/fastedge-init.md | Adds config/scaffolding guide. |
| github-pages/src/content/docs/guides/creating-a-wasm.md | Adds wasm compilation guide. |
| github-pages/src/content/docs/guides/creating-a-static-manifest.md | Updates example link target. |
| github-pages/src/content/docs/examples/variables-and-secrets.mdx | Updates examples import path to @examples alias. |
| github-pages/src/content/docs/examples/main-examples.mdx | Updates examples landing page content + Hello World entry. |
| github-pages/src/content/docs/examples/kv-store.mdx | Updates examples import path to @examples alias. |
| github-pages/src/content/docs/examples/hello-world.mdx | Adds Hello World example page sourcing example code from repo. |
| github-pages/src/content/docs/examples/headers.mdx | Updates examples import path to @examples alias. |
| github-pages/src/content/docs/examples/downstream-modify-response.mdx | Updates examples import path to @examples alias. |
| github-pages/src/content/docs/examples/downstream-fetch.mdx | Updates examples import path to @examples alias. |
| github-pages/src/content/config.ts | Adds Astro content collection config for docs schema. |
| github-pages/public/favicon.svg | Adds site favicon. |
| github-pages/public/fastedge-init-http.png | Adds guide screenshot asset. |
| github-pages/public/context7.json | Adds docs crawler/config JSON. |
| github-pages/package.json | Adds Astro docs-site package definition. |
| github-pages/docs/src/env.d.ts | Adds another Astro env types file (appears duplicate/unneeded). |
| github-pages/astro.config.mjs | Adds @examples alias + full Starlight sidebar config. |
| github-pages/.node-version | Pins a Node version for the docs site directory. |
| github-pages/.gitignore | Adds docs-site specific ignores. |
| fastedge-plugin-source/manifest.json | Adds plugin-source manifest mapping docs sources to downstream targets. |
| fastedge-plugin-source/generate-docs.sh | Adds docs generation script (LLM-driven) for docs/*.md. |
| fastedge-plugin-source/check-copilot-sync.sh | Adds validation script for manifest ↔ Copilot instructions sync. |
| fastedge-plugin-source/.generation-config.md | Adds generation rules/instructions for docs outputs. |
| examples/variables-and-secrets/src/index.js | Adds new standalone example for env + secrets. |
| examples/variables-and-secrets/package.json | Adds example package metadata/build script. |
| examples/variables-and-secrets/README.md | Adds example README. |
| examples/kv-store-basic/src/index.js | Adds new standalone KV example. |
| examples/kv-store-basic/package.json | Adds example package metadata/build script. |
| examples/kv-store-basic/README.md | Adds example README. |
| examples/hello-world/src/index.js | Updates example response text. |
| examples/hello-world/package.json | Adds example package metadata/build script. |
| examples/hello-world/README.md | Adds example README. |
| examples/headers/src/index.js | Adds new standalone headers example. |
| examples/headers/package.json | Adds example package metadata/build script. |
| examples/headers/README.md | Adds example README. |
| examples/downstream-modify-response/src/index.js | Adds downstream fetch+transform example. |
| examples/downstream-modify-response/package.json | Adds example package metadata/build script. |
| examples/downstream-modify-response/README.md | Adds example README. |
| examples/downstream-fetch/src/index.js | Adds downstream fetch passthrough example. |
| examples/downstream-fetch/package.json | Adds example package metadata/build script. |
| examples/downstream-fetch/README.md | Adds example README. |
| examples/README.md | Reworks examples index into “Getting Started” + “Full Examples”. |
| docs/src/content/docs/examples/basic.mdx | Removes old “Basic example” MDX page content. |
| docs/quickstart.md | Adds generated quickstart doc for pipeline docs set. |
| docs/STATIC_SITES.md | Adds generated static sites doc for pipeline docs set. |
| docs/SDK_API.md | Adds generated SDK API reference for pipeline docs set. |
| docs/INIT_CLI.md | Adds generated init CLI docs for pipeline docs set. |
| docs/INDEX.md | Adds generated docs index for pipeline docs set. |
| docs/BUILD_CLI.md | Adds generated build CLI docs for pipeline docs set. |
| docs/ASSETS_CLI.md | Adds generated assets CLI docs for pipeline docs set. |
| context/development/TESTING_GUIDE.md | Adds internal testing guide documentation. |
| context/development/BUILD_SYSTEM.md | Adds internal build system documentation. |
| context/architecture/RUNTIME_ARCHITECTURE.md | Adds internal runtime architecture documentation. |
| context/architecture/COMPONENTIZE_PIPELINE.md | Adds internal componentize pipeline documentation. |
| context/PROJECT_OVERVIEW.md | Adds internal project overview. |
| context/CONTEXT_INDEX.md | Adds internal context index/decision tree. |
| context/CHANGELOG.md | Adds internal changelog entries for recent repo reorganizations. |
| config/jest/jest.config.js | Updates Jest ignore pattern from docs to github-pages. |
| CLAUDE.md | Adds agent onboarding instructions (discovery-based context). |
| .github/workflows/doctor.yml | Adds scheduled “doctor” workflow. |
| .github/workflows/doctor-analyze.prompt.md | Adds prompt content for doctor analyze job. |
| .github/workflows/doctor-analyze.md | Adds reusable workflow doc/config for doctor analyze. |
| .github/workflows/docs.yaml | Updates docs deploy workflow path to github-pages/**. |
| .github/workflows/copilot-sync.yml | Adds workflow to enforce manifest ↔ Copilot-instructions sync. |
| .github/copilot-instructions.md | Adds Copilot PR review constitution + doc mapping table. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 57 out of 97 changed files in this pull request and generated 3 comments.
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
qrdl
approved these changes
Mar 26, 2026
|
🎉 This PR is included in version 2.2.1-beta.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 2.2.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
No description provided.