Skip to content

Commit ad5805d

Browse files
authored
Migrate project docs to mdBook (#3)
* docs: migrate project docs to mdbook * ci: enable dependabot updates
1 parent 154d80f commit ad5805d

56 files changed

Lines changed: 1114 additions & 2315 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/dependabot.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "cargo"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
day: "monday"
8+
time: "08:00"
9+
timezone: "Europe/London"
10+
open-pull-requests-limit: 5
11+
groups:
12+
cargo-dependencies:
13+
patterns:
14+
- "*"
15+
16+
- package-ecosystem: "github-actions"
17+
directory: "/"
18+
schedule:
19+
interval: "weekly"
20+
day: "monday"
21+
time: "08:30"
22+
timezone: "Europe/London"
23+
open-pull-requests-limit: 5
24+
groups:
25+
github-actions:
26+
patterns:
27+
- "*"

.github/workflows/docs.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: false
16+
17+
env:
18+
MDBOOK_VERSION: 0.5.2
19+
20+
jobs:
21+
build:
22+
name: Build mdBook
23+
runs-on: ubuntu-latest
24+
steps:
25+
- name: Checkout
26+
uses: actions/checkout@v6
27+
28+
- name: Install mdBook
29+
run: cargo install mdbook --version "${MDBOOK_VERSION}" --locked
30+
31+
- name: Build book
32+
run: mdbook build docs
33+
34+
- name: Configure GitHub Pages
35+
if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
36+
uses: actions/configure-pages@v6
37+
38+
- name: Upload GitHub Pages artifact
39+
if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
40+
uses: actions/upload-pages-artifact@v5
41+
with:
42+
path: docs/book
43+
44+
deploy:
45+
name: Deploy GitHub Pages
46+
if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
47+
needs: build
48+
runs-on: ubuntu-latest
49+
permissions:
50+
pages: write
51+
id-token: write
52+
environment:
53+
name: github-pages
54+
url: ${{ steps.deployment.outputs.page_url }}
55+
steps:
56+
- name: Deploy
57+
id: deployment
58+
uses: actions/deploy-pages@v5

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
/target
2+
/docs/book

AGENTS.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ cargo test -p talos-agent --test integration --features quic # + QUIC tests
3232
cd rclrs_ws && pixi run build
3333
```
3434

35+
## Default Change Workflow
36+
37+
- Make repository changes on a feature branch, not directly on `main`, unless the user explicitly asks otherwise.
38+
- After implementing and validating changes, commit them, push the branch, and open a pull request.
39+
- Keep unrelated local files out of the commit; do not stage generated output such as `docs/book/`.
40+
3541
## Architecture
3642

3743
```
@@ -71,9 +77,16 @@ The agent reads `talos-agent.toml` (or path via `--config`). Key sections:
7177
- `[control]` — optional joint command publishing
7278
- `[poses.<name>]` — named joint position presets
7379

74-
## OpenSpec Workflow
80+
## Documentation
81+
82+
The `docs/` mdBook is the canonical project documentation. Keep current behavior, architecture, usage, configuration, design history, and future plans there. `README.md` should stay short and point readers to the book.
7583

76-
The `openspec/` directory tracks architectural specs and change proposals. Use the `/opsx:propose`, `/opsx:apply`, `/opsx:archive`, and `/opsx:explore` skills to manage the spec-driven workflow.
84+
Build and preview docs with:
85+
86+
```bash
87+
mdbook build docs
88+
mdbook serve docs
89+
```
7790

7891
## Changelog Discipline
7992

CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,22 @@ those entries into the versioned section when a release is created.
77

88
## [Unreleased]
99

10+
### Added
11+
12+
- Add canonical mdBook documentation under `docs/` with current behavior, design history, and future plans.
13+
- Add a GitHub Actions workflow to build and publish the mdBook to GitHub Pages.
14+
- Add Dependabot version updates for Cargo dependencies and GitHub Actions.
15+
16+
### Changed
17+
18+
- Shorten `README.md` to a project overview that links to the mdBook.
19+
- Replace legacy spec workflow guidance with mdBook documentation guidance.
20+
- Document the default branch-and-pull-request workflow for repository changes.
21+
22+
### Removed
23+
24+
- Remove the legacy spec source tree after migrating its useful content into the mdBook.
25+
1026
## [0.1.2] - 2026-04-28
1127

1228
- No notable changes recorded.

0 commit comments

Comments
 (0)