Skip to content

Commit ad423b7

Browse files
docs: reorganize docs — move guides to docs/guides, roadmap into docs
Move docs/*.md (adding-a-language, ai-agent-guide, recommended-practices) into docs/guides/. Move roadmap/ contents (ROADMAP.md, BACKLOG.md, llm-integration.md) into docs/. Update all cross-references in README, CONTRIBUTING, STABILITY, SUPPORT, and recommended-practices.
1 parent c682f38 commit ad423b7

File tree

10 files changed

+10
-10
lines changed

10 files changed

+10
-10
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ recall will be questioned during review.
197197
Adding a new language is one of the most impactful contributions. We have a
198198
dedicated step-by-step guide:
199199

200-
**[Adding a New Language](docs/adding-a-language.md)**
200+
**[Adding a New Language](docs/guides/adding-a-language.md)**
201201

202202
This covers the full dual-engine workflow (WASM + native Rust), including every
203203
file to modify, code templates, and a verification checklist.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Or connect directly via MCP:
144144
codegraph mcp # 17-tool MCP server — AI queries the graph directly
145145
```
146146

147-
Full agent setup: [AI Agent Guide](docs/ai-agent-guide.md) · [CLAUDE.md template](docs/ai-agent-guide.md#claudemd-template)
147+
Full agent setup: [AI Agent Guide](docs/guides/ai-agent-guide.md) · [CLAUDE.md template](docs/guides/ai-agent-guide.md#claudemd-template)
148148

149149
---
150150

@@ -416,7 +416,7 @@ codegraph mcp --repos a,b # Restrict to specific repos (implies --multi-rep
416416

417417
### CLAUDE.md / Agent Instructions
418418

419-
Add this to your project's `CLAUDE.md` to help AI agents use codegraph (full template in the [AI Agent Guide](docs/ai-agent-guide.md#claudemd-template)):
419+
Add this to your project's `CLAUDE.md` to help AI agents use codegraph (full template in the [AI Agent Guide](docs/guides/ai-agent-guide.md#claudemd-template)):
420420

421421
```markdown
422422
## Code Navigation
@@ -474,15 +474,15 @@ Use `--kind function` to cut noise. Use `--file <pattern>` to scope.
474474

475475
## 📋 Recommended Practices
476476

477-
See **[docs/recommended-practices.md](docs/recommended-practices.md)** for integration guides:
477+
See **[docs/guides/recommended-practices.md](docs/guides/recommended-practices.md)** for integration guides:
478478

479479
- **Git hooks** — auto-rebuild on commit, impact checks on push, commit message enrichment
480480
- **CI/CD** — PR impact comments, threshold gates, graph caching
481481
- **AI agents** — MCP server, CLAUDE.md templates, Claude Code hooks
482482
- **Developer workflow** — watch mode, explore-before-you-edit, semantic search
483483
- **Secure credentials**`apiKeyCommand` with 1Password, Bitwarden, Vault, macOS Keychain, `pass`
484484

485-
For AI-specific integration, see the **[AI Agent Guide](docs/ai-agent-guide.md)** — a comprehensive reference covering the 6-step agent workflow, complete command-to-MCP mapping, Claude Code hooks, and token-saving patterns.
485+
For AI-specific integration, see the **[AI Agent Guide](docs/guides/ai-agent-guide.md)** — a comprehensive reference covering the 6-step agent workflow, complete command-to-MCP mapping, Claude Code hooks, and token-saving patterns.
486486

487487
## 🔁 CI / GitHub Actions
488488

@@ -619,7 +619,7 @@ npm install
619619
npm test
620620
```
621621

622-
Looking to add a new language? Check out **[Adding a New Language](docs/adding-a-language.md)**.
622+
Looking to add a new language? Check out **[Adding a New Language](docs/guides/adding-a-language.md)**.
623623

624624
## 📄 License
625625

STABILITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ LTS will be activated based on community adoption and demand — there is no fix
109109
|---------|--------------|---------|
110110
| CLI commands | Documented via `--help` and [README](README.md#-commands) | No change needed |
111111
| Programmatic API (`index.js`) | Documented in README examples | Auto-generated JSDoc reference (Phase 3+) |
112-
| MCP tools | Documented in [AI Agent Guide](docs/ai-agent-guide.md) | Versioned schema reference (Phase 3+) |
112+
| MCP tools | Documented in [AI Agent Guide](docs/guides/ai-agent-guide.md) | Versioned schema reference (Phase 3+) |
113113

114114
The planned auto-generated reference will cover all public exports from `index.js` with full type signatures, parameter descriptions, and usage examples.
115115

SUPPORT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Here are the best ways to get help with codegraph:
88

99
- [README](README.md) — Quick start, commands, features, and configuration
1010
- [CONTRIBUTING.md](CONTRIBUTING.md) — Development setup and contribution guide
11-
- [Recommended Practices](docs/recommended-practices.md) — Git hooks, CI/CD, AI agent integration
12-
- [Adding a New Language](docs/adding-a-language.md) — Step-by-step language support guide
11+
- [Recommended Practices](docs/guides/recommended-practices.md) — Git hooks, CI/CD, AI agent integration
12+
- [Adding a New Language](docs/guides/adding-a-language.md) — Step-by-step language support guide
1313

1414
### Questions & Discussions
1515

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -517,5 +517,5 @@ cp node_modules/@optave/codegraph/.github/workflows/codegraph-impact.yml .github
517517
codegraph embed
518518
519519
# 7. (Optional) Add CLAUDE.md for AI agents
520-
# See docs/ai-agent-guide.md for the full template
520+
# See docs/guides/ai-agent-guide.md for the full template
521521
```
File renamed without changes.

0 commit comments

Comments
 (0)