Conversation
There was a problem hiding this comment.
Pull request overview
This PR replaces the previous Typedoc + local web server setup with a FastEdge “plugin source” documentation pipeline, adds generated markdown docs under docs/, and introduces a Hello World example project for consumers.
Changes:
- Remove Typedoc and local dev server artifacts/config (Typedoc config, web server config, browser test page) and corresponding dependencies.
- Add
fastedge-plugin-source/tooling: manifest + doc-generation config +generate-docs.shscript for producingdocs/. - Add consumer-facing docs (
docs/SDK_API.md,docs/quickstart.md,docs/INDEX.md) and aexamples/helloWorld/starter example.
Reviewed changes
Copilot reviewed 14 out of 16 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
typedoc.json |
Removes Typedoc configuration. |
package.json |
Drops Typedoc/server scripts and adds generate:docs script. |
pnpm-lock.yaml |
Removes Typedoc/local server dependencies from lockfile. |
lws.config.cjs |
Removes local web server MIME config. |
index.html |
Removes browser-based wasm test harness page. |
fastedge-plugin-source/manifest.json |
Adds plugin-source manifest mapping sources to target reference files. |
fastedge-plugin-source/generate-docs.sh |
Adds tiered parallel doc generation script using claude. |
fastedge-plugin-source/.generation-config.md |
Adds structured generation instructions for docs/ content. |
examples/helloWorld/* |
Adds a minimal buildable “Hello World” consumer example. |
docs/quickstart.md |
Adds consumer quickstart documentation. |
docs/SDK_API.md |
Adds consumer API reference documentation. |
docs/INDEX.md |
Adds documentation index/entry point. |
.gitignore |
Stops ignoring docs/ and adjusts editor/debug artifact ignores. |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 14 out of 16 changed files in this pull request and generated 4 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.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 14 out of 16 changed files in this pull request and generated 6 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.
|
🎉 This PR is included in version 1.2.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
No description provided.