-
Notifications
You must be signed in to change notification settings - Fork 61
docs: move experiments from Internals to Contributing section #2853
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
1304a71
docs: move experiments from Internals to Contributing section
waynesun09 8562d22
fix: auto-init submodules on local dev/build
waynesun09 767e138
docs: split site-deployment into web-admin and doc-site guides
waynesun09 4868364
docs: reorder sidebar and shorten Web Admin nav label
waynesun09 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Documentation site | ||
|
|
||
| The documentation site is built with **[VitePress](https://vitepress.dev/)**. Markdown source lives in `docs/`, site configuration in `website/.vitepress/config.ts`, and build output in `website/dist/`. | ||
|
|
||
| ## Local development | ||
|
|
||
| ```bash | ||
| cd website | ||
| npm ci | ||
| npm run dev | ||
| ``` | ||
|
|
||
| The dev server starts on `http://localhost:5173/docs/`. Submodules (e.g. `experiments/`) are initialized automatically via a `predev` hook — no manual `git submodule` step needed. | ||
|
|
||
| ## Building | ||
|
|
||
| ```bash | ||
| cd website | ||
| npm run build | ||
| ``` | ||
|
|
||
| A `prebuild` hook runs `git submodule update --init` before the VitePress build, matching CI behavior. | ||
|
|
||
| ## How it works | ||
|
|
||
| - `docs/` contains all markdown content, organized by section (agents, guides, ADRs, etc.) | ||
| - `website/.vitepress/config.ts` defines the sidebar navigation and markdown processing | ||
| - `getMarkdownFiles()` auto-discovers markdown files and subdirectory READMEs for dynamic sidebar sections (ADRs, experiments, design docs, specs, plans) | ||
| - Symlinks connect submodule content into `docs/` (e.g. `docs/experiments` → `../experiments`) | ||
|
|
||
| ## Submodules | ||
|
|
||
| Some doc content lives in separate repositories linked as git submodules: | ||
|
|
||
| | Submodule | Path | Docs symlink | | ||
| |-----------|------|-------------| | ||
| | [fullsend-ai/experiments](https://github.com/fullsend-ai/experiments) | `experiments/` | `docs/experiments` → `../experiments` | | ||
|
|
||
| The `predev` and `prebuild` hooks in `website/package.json` handle initialization automatically for local dev. CI uses `submodules: true` on `actions/checkout` in `.github/workflows/site-build.yml`. | ||
|
|
||
| ## CI/CD | ||
|
|
||
| - **`.github/workflows/site-build.yml`** — builds the VitePress site on PRs and pushes to `main`, uploads the artifact | ||
| - **`.github/workflows/site-deploy.yml`** — deploys the built artifact to Cloudflare Workers on `main` pushes, uploads preview versions on PRs | ||
|
|
||
| For Cloudflare Worker setup, secrets, and troubleshooting, see [`web-admin-deployment.md`](web-admin-deployment.md). |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../experiments |
2 changes: 0 additions & 2 deletions
2
docs/superpowers/experiments/oauth-localhost-part-b/.gitignore
This file was deleted.
Oops, something went wrong.
70 changes: 0 additions & 70 deletions
70
docs/superpowers/experiments/oauth-localhost-part-b/README.md
This file was deleted.
Oops, something went wrong.
19 changes: 0 additions & 19 deletions
19
docs/superpowers/experiments/oauth-localhost-part-b/index.html
This file was deleted.
Oops, something went wrong.
18 changes: 0 additions & 18 deletions
18
docs/superpowers/experiments/oauth-localhost-part-b/oauth/callback.html
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.