Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Docs (rspress → Pages)

on:
push:
branches: [main]
pull_request:
paths:
- "docs/**"
- ".github/workflows/docs.yml"
workflow_dispatch:

# Pages needs `pages: write` + `id-token: write` on the deploying job.
permissions:
contents: read
pages: write
id-token: write

# One deploy at a time; cancel queued runs of the same branch.
concurrency:
group: "pages"
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
cache-dependency-path: docs/package-lock.json
- name: Install docs dependencies
run: npm ci
working-directory: docs
- name: Build docs
run: npm run build
working-directory: docs
- name: Setup Pages
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/configure-pages@v5
- name: Upload Pages artifact
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v3
with:
path: docs/doc_build

deploy:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
44 changes: 0 additions & 44 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,47 +17,3 @@ jobs:
with:
name: dist
path: dist/

docs-build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
cache-dependency-path: docs/package-lock.json

- name: Install docs dependencies
run: npm ci
working-directory: docs

- name: Build docs
run: npm run build
working-directory: docs

- name: Setup Pages
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/configure-pages@v5

- name: Upload Pages artifact
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v3
with:
path: docs/doc_build

docs-deploy:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
needs: docs-build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,6 @@ If a future PR adds any of those, document why in the PR description and update
| Test suite | `tests/`, run via `uv run pytest -q` |
| Lint config | `[tool.ruff]` in `pyproject.toml` |
| Source modules | `src/coding_scaffold/` |
| Wiki | `docs/wiki/` (relative-link Markdown, renders on GitHub) |
| Wiki | `docs/docs/wiki/` (Markdown source for rspress; also published to GitHub Pages) |
| Release notes | `CHANGELOG.md` |
| CI | `.github/workflows/ci.yml` — runs ruff + pytest on push to main and on every PR |
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ ignore for now. `pilot` is a safe guided wrapper — it runs only read-only loca
the exact commands to run next. Neither command installs anything or writes files; the
recipe they print may include `--install` flags, but you make that call.

> Looking for a specific entry point? See the [persona paths](docs/wiki/Team-Rollout.md#persona-paths)
> Looking for a specific entry point? See the [persona paths](docs/docs/wiki/Team-Rollout.md#persona-paths)
> (beginner / control-and-reproducibility / security review / team lead). For the threat model
> and what the scaffold deliberately does not enforce, read [Security](docs/wiki/Security.md#threat-model).
> and what the scaffold deliberately does not enforce, read [Security](docs/docs/wiki/Security.md#threat-model).
> Release notes are in [CHANGELOG.md](CHANGELOG.md).

CodingScaffold prepares an existing project for AI-assisted development without tying the team to
Expand Down Expand Up @@ -411,7 +411,7 @@ coding-scaffold tools adapt --target ~/dev/my-project --tool pi

For the full capability-by-capability breakdown (install support, permissions, MCP, local models,
cloud providers, static profiles, runtime routing, etc.) see the
[compatibility matrix in Tool Adapters](docs/wiki/Tool-Adapters.md#compatibility-matrix) — that's
[compatibility matrix in Tool Adapters](docs/docs/wiki/Tool-Adapters.md#compatibility-matrix) — that's
the single source of truth; this table is a scannable summary.

## Knowledge Base
Expand All @@ -427,7 +427,7 @@ coding-scaffold knowledge create --target ~/dev/my-project

New knowledge bases include raw inputs, a curated wiki, decision records, session notes, and
optional hierarchical-sharing layers (`team` / `department` / `unit` / `company`). See
[Knowledge Base](docs/wiki/Knowledge-Base.md) for the full tree. The shorthand:
[Knowledge Base](docs/docs/wiki/Knowledge-Base.md) for the full tree. The shorthand:

```text
.coding-scaffold/knowledge/
Expand Down
47 changes: 34 additions & 13 deletions docs/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading