Skip to content

Commit 5dd2302

Browse files
chuongld20claude
andcommitted
fix: add MCP docs to nav, update stale "coming soon" text
- Add MCP Server Reference and Agent Farm Setup to mkdocs.yml nav - Replace "Coming Soon" MCP section in agent-builder guide with links to actual MCP reference docs (ISS-61–66 shipped) - Resolve README.md merge conflict, add MCP reference link Addresses review feedback on ISS-69. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 17570a1 commit 5dd2302

21 files changed

Lines changed: 2566 additions & 178 deletions

.claude/scheduled_tasks.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"sessionId":"f9f1e5ad-00a2-4034-812b-4a9eb6a494b7","pid":741641,"acquiredAt":1776017431094}
1+
{"sessionId":"86183107-55ff-43c0-9405-4b4716b393cf","pid":3195439,"acquiredAt":1776108037837}

.claude/skills/devbox-lead/references/issue-dependency-graph.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,28 @@ ISS-50 ──┬──→ ISS-51 (plugin) → ISS-52 (community templates) ─
4444
└──→ ISS-53 (CI/CD preview) ──────────────────────────┤──→ ISS-54 (Review) ★ GATE
4545
```
4646

47+
## Phase 5: MCP & Agent Farm (blocked by ISS-54)
48+
```
49+
ISS-54 ──→ ISS-61 (MCP Core Tools) ──┬──→ ISS-62 (Server & Resource Tools) ──┐
50+
├──→ ISS-63 (Snapshot & Template Tools) ┤
51+
└──→ ISS-64 (Agent Farm Sessions) ──────┤
52+
53+
ISS-65 (Tests)
54+
55+
ISS-66 (Docs)
56+
57+
ISS-67 (Review) ★ GATE
58+
```
59+
60+
## Phase 6: Website & Docs (parallel with Phase 5)
61+
```
62+
ISS-69 (MkDocs Setup) ──→ ISS-70 (Landing Page) ──→ ISS-72 (Migration/FAQ)
63+
│ │
64+
└──→ ISS-71 (User Guides) ────────────────────────────┤
65+
66+
ISS-73 (Review) ★ GATE
67+
```
68+
4769
## Document IDs (for MCP calls)
4870
| ISS | documentId |
4971
|-----|-----------|
@@ -79,3 +101,15 @@ ISS-50 ──┬──→ ISS-51 (plugin) → ISS-52 (community templates) ─
79101
| 52 | a8hqmlitrk2sp8q7ko88r3nr |
80102
| 53 | p45ldoiyrmn3tc3ucqdnfx7t |
81103
| 54 | uz93t6ov36id0qxiylt8442r |
104+
| 61 | vodbmcqjoivt4urctmfntkgm |
105+
| 62 | bj86l32s9ufog3pllpes9006 |
106+
| 63 | khw47k3zn4gxwre3sg0q0o4w |
107+
| 64 | f5pvcc11f6gsq6cboxa0c4gl |
108+
| 65 | apdrgmt5c2afrc9x7z79y6ds |
109+
| 66 | sbfna8dv8n66nuf2kd9csssw |
110+
| 67 | yo6e3q3vq0h6pafvgl2rjfcx |
111+
| 69 | orzxxbzjryowdynxtp667z94 |
112+
| 70 | jd8n8phlcd8ijrs3kv01mo2k |
113+
| 71 | dh2w92is9f7agdat9k4486m7 |
114+
| 72 | fn90qhfoe10scamk9v56rm6i |
115+
| 73 | r5ins098mlsfgxx2lz3mqfy8 |

.github/workflows/docs.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'docs/**'
8+
- 'mkdocs.yml'
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- uses: actions/checkout@v4
25+
- uses: actions/setup-python@v5
26+
with:
27+
python-version: '3.12'
28+
- run: pip install mkdocs-material
29+
- run: mkdocs build --strict
30+
- uses: actions/upload-pages-artifact@v3
31+
with:
32+
path: site
33+
34+
deploy:
35+
needs: build
36+
runs-on: ubuntu-latest
37+
environment:
38+
name: github-pages
39+
url: ${{ steps.deployment.outputs.page_url }}
40+
steps:
41+
- id: deployment
42+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,7 @@ Thumbs.db
3737
devbox.yaml
3838
*.log
3939
/tmp/
40+
41+
# MkDocs
42+
/site/
43+
.venv/

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,11 +113,17 @@ devbox exposes all operations via the [Model Context Protocol (MCP)](https://mod
113113

114114
## Documentation
115115

116-
- [Quick Start Guide](docs/QUICKSTART.md) — from install to `devbox up` in 15 minutes
117-
- [Configuration Reference](docs/CONFIG.md) — all `devbox.yaml` fields explained
118-
- [MCP Server Reference](docs/MCP.md) — AI agent integration via Model Context Protocol
119-
- [Agent Farm Setup Guide](docs/AGENT_FARM.md) — multi-agent workspace management
120-
- [Troubleshooting](docs/TROUBLESHOOTING.md) — common issues and fixes
116+
**[https://junixlabs.github.io/devbox](https://junixlabs.github.io/devbox)**
117+
118+
- [Quick Start Guide](https://junixlabs.github.io/devbox/getting-started/quickstart/) — from install to `devbox up` in 15 minutes
119+
- [Configuration Reference](https://junixlabs.github.io/devbox/getting-started/config/) — all `devbox.yaml` fields explained
120+
- [Developer Guide](https://junixlabs.github.io/devbox/guides/developer/) — daily workflow, templates, snapshots
121+
- [Admin Guide](https://junixlabs.github.io/devbox/guides/admin/) — server pools, user isolation, monitoring
122+
- [AI Agent Builder Guide](https://junixlabs.github.io/devbox/guides/agent-builder/) — workspace-per-agent, MCP integration
123+
- [MCP Server Reference](https://junixlabs.github.io/devbox/reference/mcp-server/) — AI agent integration via Model Context Protocol
124+
- [Plugin API](https://junixlabs.github.io/devbox/reference/plugin-api/) — extend devbox with custom providers and hooks
125+
- [Troubleshooting](https://junixlabs.github.io/devbox/reference/troubleshooting/) — common issues and fixes
126+
- [FAQ](https://junixlabs.github.io/devbox/reference/faq/) — frequently asked questions
121127

122128
## License
123129

docs/QUICKSTART.md

Lines changed: 0 additions & 165 deletions
This file was deleted.
Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,16 +84,29 @@ CLI flags take precedence over `devbox.yaml` values.
8484

8585
## Creating a config
8686

87-
Use `devbox init` to create a config interactively:
87+
### Interactive
8888

8989
```bash
9090
devbox init
9191
```
9292

93-
Or convert from an existing Docker Compose file:
93+
### From Docker Compose
9494

9595
```bash
9696
devbox init --from-compose docker-compose.yml
9797
```
9898

99-
See [devbox.yaml.example](../devbox.yaml.example) for a complete annotated example.
99+
This extracts services and port mappings from your existing Compose file.
100+
101+
### From a template
102+
103+
```bash
104+
devbox template list # See available templates
105+
devbox init --template go # Use a built-in template
106+
```
107+
108+
Built-in templates include: Go, Python, Node.js, Rails, Laravel, Next.js, Django, Rust.
109+
110+
## devcontainer.json support
111+
112+
devbox also reads `.devcontainer/devcontainer.json` as a fallback configuration source, following the [Development Container Specification](https://containers.dev/).

0 commit comments

Comments
 (0)