Skip to content

Commit 6e07940

Browse files
committed
docs: update documentation source path references
Update all documentation references to reflect canonical source now located at docs-site/src/content/docs/ instead of the old docs/ folder. - Update AGENTS.md and CLAUDE.md agent guidance with new doc paths - Update README.md, CHANGELOG.md, CONTRIBUTING.md project references - Fix editUrl in all docs-site content files to point to new location - Update docs-site README to reflect canonical source location - Correct OpenCode upstream URL to opencode-ai organization
1 parent 448e778 commit 6e07940

26 files changed

Lines changed: 112 additions & 104 deletions

AGENTS.md

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -34,26 +34,24 @@ Supported Claude Code integration mechanisms documented in this repo:
3434

3535
When updating docs or implementing features, verify claims using these sources.
3636

37-
> Note: Some references below include example local paths from one development machine. If you do not have these repos checked out locally, use the upstream GitHub repositories and adjust paths accordingly.
38-
3937
- **ReCursor docs (the contract):**
40-
- `C:/Repository/ReCursor/docs/README.md`
41-
- `C:/Repository/ReCursor/docs/architecture/overview.md`
42-
- `C:/Repository/ReCursor/docs/integration/`
38+
- `docs-site/src/content/docs/` (canonical documentation source)
39+
- `docs-site/src/content/docs/architecture/system-overview.md`
40+
- `docs-site/src/content/docs/integrations/`
4341

4442
- **OpenCode UI patterns (desktop parity reference):**
45-
- Upstream repo: https://github.com/anomalyco/opencode
46-
- Local repo (optional): `C:/Repository/opencode/`
47-
- Especially: `C:/Repository/opencode/packages/ui/src/components/`
43+
- Upstream repo: https://github.com/opencode-ai/opencode
44+
- Key path: `packages/ui/src/components/`
4845

4946
- **Claude Code supported extension points:**
5047
- Upstream repo: https://github.com/anthropics/claude-code
51-
- Local repo (optional): `C:/Repository/claude-code/`
52-
- Especially: `C:/Repository/claude-code/plugins/plugin-dev/skills/hook-development/`
48+
- Key paths:
49+
- `plugins/plugin-dev/skills/hook-development/SKILL.md`
50+
- `plugins/hookify/hooks/hooks.json`
5351

5452
- **Official docs:**
55-
- Claude Code docs: https://code.claude.com/docs/
56-
- Agent SDK docs: https://docs.claude.com/en/api/agent-sdk/overview
53+
- Claude Code docs: https://docs.anthropic.com/en/docs/claude-code
54+
- Agent SDK docs: https://docs.anthropic.com/en/api/agent-sdk
5755

5856
If something is not in the above sources, treat it as **unknown** and document it as an **open question**.
5957

@@ -62,12 +60,14 @@ If something is not in the above sources, treat it as **unknown** and document i
6260
## 3) Repo layout (scaffold)
6361

6462
```text
65-
C:/Repository/ReCursor/
66-
├── apps/mobile/ # Flutter app scaffold (no implementation yet)
67-
├── packages/bridge/ # Node/TypeScript bridge scaffold (no implementation yet)
68-
├── docs/ # Project documentation (source-of-truth)
69-
├── .github/ # CI scaffolding
70-
└── fastlane/ # Release scaffolding
63+
ReCursor/
64+
├── apps/mobile/ # Flutter app scaffold
65+
├── packages/bridge/ # Node/TypeScript bridge scaffold
66+
├── packages/claude-plugin/ # Claude Code plugin scaffold
67+
├── docs-site/ # Astro Starlight documentation site
68+
│ └── src/content/docs/ # Canonical documentation source
69+
├── .github/ # CI scaffolding
70+
└── fastlane/ # Release scaffolding
7171
```
7272

7373
---
@@ -81,7 +81,7 @@ C:/Repository/ReCursor/
8181
- Keep edits strictly within the requested scope.
8282
- Prefer small, reviewable commits/changesets.
8383
- When changing docs, keep them **internally consistent** (cross-links, terminology).
84-
- When making factual claims about OpenCode/Claude Code behavior, include a citation (path + short excerpt) in your PR description.
84+
- When making factual claims about OpenCode/Claude Code behavior, include a citation (URL + short excerpt) in your PR description.
8585

8686
**Don't:**
8787
- Do not introduce claims like "ReCursor mirrors Claude Code Remote Control sessions" unless official docs explicitly support third‑party clients.
@@ -93,9 +93,9 @@ C:/Repository/ReCursor/
9393
Before marking docs work complete:
9494
- Ensure internal links resolve.
9595
- Search for outdated branding/terms that should not exist.
96-
- For Claude Code hooks docs, ensure you are aligned with:
97-
- `C:/Repository/claude-code/plugins/plugin-dev/skills/hook-development/SKILL.md`
98-
- `C:/Repository/claude-code/plugins/hookify/hooks/hooks.json`
96+
- For Claude Code hooks docs, ensure you are aligned with the upstream repo:
97+
- `plugins/plugin-dev/skills/hook-development/SKILL.md`
98+
- `plugins/hookify/hooks/hooks.json`
9999

100100
### 4.3 Commit message guidelines
101101

@@ -133,19 +133,22 @@ Future agent integrations will follow the adapter pattern established by the Cla
133133
## 5) Preferred workflow for future implementation
134134

135135
When implementation is requested:
136+
136137
1. **Confirm scope**: which subproject(s) are being built (Flutter app, bridge, both).
137-
2. **Follow docs**: treat `docs/` as the contract; if docs are wrong, fix docs first.
138-
3. **Implement minimal vertical slices**: scaffold → connect → render a small set of UI components.
138+
2. **Follow docs**: treat `docs-site/src/content/docs/` as the contract; if docs are wrong, fix docs first.
139+
3. **Work efficiently in parallel**:
140+
- Identify independent tasks that can be executed concurrently (file reads, searches, analysis)
141+
- Batch related operations to minimize context switches
142+
- Use parallel tool invocations where dependencies allow
143+
- Prefer complete, working solutions over piecemeal slices
139144
4. **Verify** with build/lint/test commands appropriate to the stack.
140145

141146
---
142147

143148
## 6) Quick links for agents
144149

145-
- Docs index: `C:/Repository/ReCursor/docs/README.md`
146-
- Plan: `C:/Repository/ReCursor/docs/PLAN.md`
147-
- OpenCode UI mapping: `C:/Repository/ReCursor/docs/integration/opencode-ui-patterns.md`
148-
- Claude Code hooks: `C:/Repository/ReCursor/docs/integration/claude-code-hooks.md`
149-
- Agent SDK: `C:/Repository/ReCursor/docs/integration/agent-sdk.md`
150-
- OpenCode upstream: https://github.com/anomalyco/opencode
151-
- Claude Code upstream: https://github.com/anthropics/claude-code
150+
- **Docs index:** `docs-site/src/content/docs/index.mdx`
151+
- **Architecture:** `docs-site/src/content/docs/architecture/system-overview.md`
152+
- **Integrations:** `docs-site/src/content/docs/integrations/`
153+
- **OpenCode upstream:** https://github.com/opencode-ai/opencode
154+
- **Claude Code upstream:** https://github.com/anthropics/claude-code

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
### Added
1111

1212
#### Monorepo Infrastructure
13-
- Monorepo scaffolding with `apps/`, `packages/`, `docs/`, `.github/`, `fastlane/` structure
13+
- Monorepo scaffolding with `apps/`, `packages/`, `docs-site/`, `.github/`, `fastlane/` structure
1414
- Development helper scripts in `tool/` for bridge and mobile workflows
1515
- Pre-commit hooks for format and check enforcement
1616
- Repository governance documents: `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `SECURITY.md`
@@ -49,7 +49,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4949
- Serif typography (Crimson Pro) for headings, Inter for body/UI
5050
- Warm off-white palette with refined ink tones and dark mode support
5151

52-
#### Documentation (`docs/`)
52+
#### Documentation (`docs-site/`)
5353
- Architecture: `overview.md`, `data-flow.md`
5454
- Integration guides: `claude-code-hooks.md`, `agent-sdk.md`, `opencode-ui-patterns.md`
5555
- Protocol specs: `bridge-protocol.md`, `bridge-http-api.md`, `error-handling.md`, `type-mapping.md`

CLAUDE.md

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -34,26 +34,24 @@ Supported Claude Code integration mechanisms documented in this repo:
3434

3535
When updating docs or implementing features, verify claims using these sources.
3636

37-
> Note: Some references below include example local paths from one development machine. If you do not have these repos checked out locally, use the upstream GitHub repositories and adjust paths accordingly.
38-
3937
- **ReCursor docs (the contract):**
40-
- `C:/Repository/ReCursor/docs/README.md`
41-
- `C:/Repository/ReCursor/docs/architecture/overview.md`
42-
- `C:/Repository/ReCursor/docs/integration/`
38+
- `docs-site/src/content/docs/` (canonical documentation source)
39+
- `docs-site/src/content/docs/architecture/system-overview.md`
40+
- `docs-site/src/content/docs/integrations/`
4341

4442
- **OpenCode UI patterns (desktop parity reference):**
45-
- Upstream repo: https://github.com/anomalyco/opencode
46-
- Local repo (optional): `C:/Repository/opencode/`
47-
- Especially: `C:/Repository/opencode/packages/ui/src/components/`
43+
- Upstream repo: https://github.com/opencode-ai/opencode
44+
- Key path: `packages/ui/src/components/`
4845

4946
- **Claude Code supported extension points:**
5047
- Upstream repo: https://github.com/anthropics/claude-code
51-
- Local repo (optional): `C:/Repository/claude-code/`
52-
- Especially: `C:/Repository/claude-code/plugins/plugin-dev/skills/hook-development/`
48+
- Key paths:
49+
- `plugins/plugin-dev/skills/hook-development/SKILL.md`
50+
- `plugins/hookify/hooks/hooks.json`
5351

5452
- **Official docs:**
55-
- Claude Code docs: https://code.claude.com/docs/
56-
- Agent SDK docs: https://docs.claude.com/en/api/agent-sdk/overview
53+
- Claude Code docs: https://docs.anthropic.com/en/docs/claude-code
54+
- Agent SDK docs: https://docs.anthropic.com/en/api/agent-sdk
5755

5856
If something is not in the above sources, treat it as **unknown** and document it as an **open question**.
5957

@@ -62,12 +60,14 @@ If something is not in the above sources, treat it as **unknown** and document i
6260
## 3) Repo layout (scaffold)
6361

6462
```text
65-
C:/Repository/ReCursor/
66-
├── apps/mobile/ # Flutter app scaffold (no implementation yet)
67-
├── packages/bridge/ # Node/TypeScript bridge scaffold (no implementation yet)
68-
├── docs/ # Project documentation (source-of-truth)
69-
├── .github/ # CI scaffolding
70-
└── fastlane/ # Release scaffolding
63+
ReCursor/
64+
├── apps/mobile/ # Flutter app scaffold
65+
├── packages/bridge/ # Node/TypeScript bridge scaffold
66+
├── packages/claude-plugin/ # Claude Code plugin scaffold
67+
├── docs-site/ # Astro Starlight documentation site
68+
│ └── src/content/docs/ # Canonical documentation source
69+
├── .github/ # CI scaffolding
70+
└── fastlane/ # Release scaffolding
7171
```
7272

7373
---
@@ -81,7 +81,7 @@ C:/Repository/ReCursor/
8181
- Keep edits strictly within the requested scope.
8282
- Prefer small, reviewable commits/changesets.
8383
- When changing docs, keep them **internally consistent** (cross-links, terminology).
84-
- When making factual claims about OpenCode/Claude Code behavior, include a citation (path + short excerpt) in your PR description.
84+
- When making factual claims about OpenCode/Claude Code behavior, include a citation (URL + short excerpt) in your PR description.
8585

8686
**Don't:**
8787
- Do not introduce claims like "ReCursor mirrors Claude Code Remote Control sessions" unless official docs explicitly support third‑party clients.
@@ -93,9 +93,9 @@ C:/Repository/ReCursor/
9393
Before marking docs work complete:
9494
- Ensure internal links resolve.
9595
- Search for outdated branding/terms that should not exist.
96-
- For Claude Code hooks docs, ensure you are aligned with:
97-
- `C:/Repository/claude-code/plugins/plugin-dev/skills/hook-development/SKILL.md`
98-
- `C:/Repository/claude-code/plugins/hookify/hooks/hooks.json`
96+
- For Claude Code hooks docs, ensure you are aligned with the upstream repo:
97+
- `plugins/plugin-dev/skills/hook-development/SKILL.md`
98+
- `plugins/hookify/hooks/hooks.json`
9999

100100
### 4.3 Commit message guidelines
101101

@@ -133,19 +133,22 @@ Future agent integrations will follow the adapter pattern established by the Cla
133133
## 5) Preferred workflow for future implementation
134134

135135
When implementation is requested:
136+
136137
1. **Confirm scope**: which subproject(s) are being built (Flutter app, bridge, both).
137-
2. **Follow docs**: treat `docs/` as the contract; if docs are wrong, fix docs first.
138-
3. **Implement minimal vertical slices**: scaffold → connect → render a small set of UI components.
138+
2. **Follow docs**: treat `docs-site/src/content/docs/` as the contract; if docs are wrong, fix docs first.
139+
3. **Work efficiently in parallel**:
140+
- Identify independent tasks that can be executed concurrently (file reads, searches, analysis)
141+
- Batch related operations to minimize context switches
142+
- Use parallel tool invocations where dependencies allow
143+
- Prefer complete, working solutions over piecemeal slices
139144
4. **Verify** with build/lint/test commands appropriate to the stack.
140145

141146
---
142147

143148
## 6) Quick links for agents
144149

145-
- Docs index: `C:/Repository/ReCursor/docs/README.md`
146-
- Plan: `C:/Repository/ReCursor/docs/PLAN.md`
147-
- OpenCode UI mapping: `C:/Repository/ReCursor/docs/integration/opencode-ui-patterns.md`
148-
- Claude Code hooks: `C:/Repository/ReCursor/docs/integration/claude-code-hooks.md`
149-
- Agent SDK: `C:/Repository/ReCursor/docs/integration/agent-sdk.md`
150-
- OpenCode upstream: https://github.com/anomalyco/opencode
151-
- Claude Code upstream: https://github.com/anthropics/claude-code
150+
- **Docs index:** `docs-site/src/content/docs/index.mdx`
151+
- **Architecture:** `docs-site/src/content/docs/architecture/system-overview.md`
152+
- **Integrations:** `docs-site/src/content/docs/integrations/`
153+
- **OpenCode upstream:** https://github.com/opencode-ai/opencode
154+
- **Claude Code upstream:** https://github.com/anthropics/claude-code

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,8 @@ By participating, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
1010

1111
## Quick links
1212

13-
- Docs index (source of truth): `docs/README.md`
14-
- Architecture overview: `docs/architecture/overview.md`
15-
- Plan / roadmap: `docs/PLAN.md`
13+
- Docs index (source of truth): `docs-site/src/content/docs/index.mdx`
14+
- Architecture overview: `docs-site/src/content/docs/architecture/system-overview.md`
1615
- Agentic AI guidance: `AGENTS.md`
1716

1817
## What you can contribute right now
@@ -29,7 +28,9 @@ Because implementation is not yet complete, these contribution types are most he
2928
C:/Repository/ReCursor/
3029
├── apps/mobile/ # Flutter app scaffold
3130
├── packages/bridge/ # Node/TypeScript bridge scaffold
32-
└── docs/ # Documentation (architecture + integration guides)
31+
├── docs-site/ # Documentation site (Astro Starlight)
32+
│ └── src/content/docs/ # Canonical documentation source
33+
└── packages/claude-plugin/ # Claude Code plugin scaffold
3334
```
3435

3536
## Development prerequisites (for future work)

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
<a href="#project-status">
3434
<img src="https://img.shields.io/badge/Status-WIP-orange?style=flat-square" alt="Status: WIP">
3535
</a>
36-
<a href="docs/README.md">
36+
<a href="docs-site/src/content/docs/index.mdx">
3737
<img src="https://img.shields.io/badge/Docs-Start%20Here-blue?style=flat-square" alt="Docs">
3838
</a>
3939
<a href="https://github.com/RecursiveDev/ReCursor/issues">
@@ -62,7 +62,7 @@ This repository is **work in progress**, but the current Claude-first MVP is no
6262
- ✅ Git status, diff viewing, and repository browsing are implemented for the current mobile/bridge stack.
6363
- ⏳ Remaining work is focused on polish: approval UX refinement, notification center UI, and future multi-agent expansion.
6464

65-
If you're new here, start with: **`docs/README.md`**, `docs/architecture/overview.md`, and `docs/architecture/REMAINING_PHASES.md`.
65+
If you're new here, start with: **`docs-site/src/content/docs/`** (browse the docs-site content or run `npm run dev` in `docs-site/` to view locally).
6666

6767
---
6868

@@ -115,15 +115,16 @@ C:/Repository/ReCursor/
115115

116116
## Documentation
117117

118-
- **Canonical docs index:** `docs/README.md`
119-
- **Published docs site source:** `docs-site/`
120-
- **Run the docs site locally:** `cd docs-site && npm install && npm run dev`
121-
- **Architecture overview:** `docs/architecture/overview.md`
122-
- **Data flow diagrams:** `docs/architecture/data-flow.md`
118+
- **Published docs site:** `docs-site/` — run `npm install && npm run dev` to view locally
119+
- **Docs landing page:** [docs-site/src/content/docs/index.mdx](docs-site/src/content/docs/index.mdx)
120+
- **Architecture:**
121+
- System overview: [docs-site/src/content/docs/architecture/system-overview.md](docs-site/src/content/docs/architecture/system-overview.md)
122+
- Data flow: [docs-site/src/content/docs/architecture/data-flow.md](docs-site/src/content/docs/architecture/data-flow.md)
123+
- Bridge protocol: [docs-site/src/content/docs/architecture/bridge-protocol.md](docs-site/src/content/docs/architecture/bridge-protocol.md)
123124
- **Integrations:**
124-
- OpenCode UI patterns: `docs/integration/opencode-ui-patterns.md`
125-
- Claude Code Hooks: `docs/integration/claude-code-hooks.md`
126-
- Agent SDK: `docs/integration/agent-sdk.md`
125+
- OpenCode UI patterns: [docs-site/src/content/docs/integrations/opencode-ui-patterns.md](docs-site/src/content/docs/integrations/opencode-ui-patterns.md)
126+
- Claude Code Hooks: [docs-site/src/content/docs/integrations/claude-code-hooks.md](docs-site/src/content/docs/integrations/claude-code-hooks.md)
127+
- Agent SDK: [docs-site/src/content/docs/integrations/agent-sdk.md](docs-site/src/content/docs/integrations/agent-sdk.md)
127128

128129
---
129130

docs-site/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ This folder contains the Astro Starlight documentation site for ReCursor.
44

55
## How it works
66

7-
- Canonical Markdown source lives in `C:/Repository/ReCursor/docs/`.
8-
- `npm run generate` copies that source into `src/content/docs/`, rewrites internal links to the published information architecture, and generates `public/llms.txt` plus `public/llms-full.txt`.
7+
- Canonical Markdown source lives in `src/content/docs/` within this docs-site folder.
98
- Section landing pages in `src/content/docs/` provide the curated Starlight navigation layer.
9+
- Run `npm run dev` to preview locally, `npm run build` to build for production.
1010

1111
## Commands
1212

@@ -19,6 +19,5 @@ npm run build
1919

2020
## Editing guidance
2121

22-
- Update canonical content in `C:/Repository/ReCursor/docs/` whenever possible.
23-
- Update `scripts/docs-manifest.mjs` if a source document is added, renamed, or moved in the published site.
22+
- Update content directly in `src/content/docs/` within this repository.
2423
- Keep claims about Claude Code aligned with `C:/Repository/ReCursor/AGENTS.md`.

docs-site/src/content/docs/architecture/bridge-protocol.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Bridge Protocol Specification"
33
description: "WebSocket message protocol between the ReCursor Flutter mobile app and the user-controlled TypeScript bridge server. Bridge-first, no-login: device pairing via QR code, no user accounts."
4-
editUrl: "https://github.com/RecursiveDev/ReCursor/edit/main/docs/bridge-protocol.md"
4+
editUrl: "https://github.com/RecursiveDev/ReCursor/edit/main/docs-site/src/content/docs/bridge-protocol.md"
55
sidebar:
66
order: 50
77
label: "Bridge protocol"

docs-site/src/content/docs/architecture/data-flow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Data Flow Architecture"
33
description: "Message flow between ReCursor mobile app, bridge server, and Claude Code via Hooks."
4-
editUrl: "https://github.com/RecursiveDev/ReCursor/edit/main/docs/architecture/data-flow.md"
4+
editUrl: "https://github.com/RecursiveDev/ReCursor/edit/main/docs-site/src/content/docs/architecture/data-flow.md"
55
sidebar:
66
order: 20
77
label: "Data flow"

docs-site/src/content/docs/architecture/data-models.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Data Models"
33
description: "Drift schemas, Hive models, and domain entities for ReCursor."
4-
editUrl: "https://github.com/RecursiveDev/ReCursor/edit/main/docs/data-models.md"
4+
editUrl: "https://github.com/RecursiveDev/ReCursor/edit/main/docs-site/src/content/docs/data-models.md"
55
sidebar:
66
order: 40
77
label: "Data models"

docs-site/src/content/docs/architecture/project-structure.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Project Structure"
33
description: "Flutter directory layout and module organization for ReCursor."
4-
editUrl: "https://github.com/RecursiveDev/ReCursor/edit/main/docs/project-structure.md"
4+
editUrl: "https://github.com/RecursiveDev/ReCursor/edit/main/docs-site/src/content/docs/project-structure.md"
55
sidebar:
66
order: 30
77
label: "Project structure"
@@ -43,7 +43,8 @@ recursor/
4343
│ ├── package.json
4444
│ └── tsconfig.json
4545
46-
├── docs/ # Documentation (this folder)
46+
├── docs-site/ # Documentation (Astro Starlight site)
47+
│ └── src/content/docs/ # Canonical documentation source
4748
├── .github/
4849
│ └── workflows/ # CI/CD pipelines
4950
│ ├── test.yml # PR test pipeline

0 commit comments

Comments
 (0)