Add doc-weaver: TypeScript documentation compiler

TypeDoc + JSDoc (RDFC) compiler mirroring doc-forge. Emits a
doc-forge-shaped MCP JSON bundle and a TypeDoc human site, with an MCP
server (official SDK, stdio), a build/serve CLI, and React-aware kind
classification. Includes the RDFC wiki (docs/wiki) and MkDocs config.
This commit is contained in:
2026-10-18 12:17:18 +05:30
parent bb3767ac15
commit f7a997b4ce
23 changed files with 3404 additions and 0 deletions

55
docs/wiki/index.md Normal file
View File

@@ -0,0 +1,55 @@
# 🪡 doc-weaver — TypeScript Documentation Weaver
`doc-weaver` is the TypeScript counterpart to `doc-forge`. It compiles
JSDoc-annotated TypeScript into a **TypeDoc** site (the MkDocs parallel) and a
**doc-forge-shaped MCP JSON bundle**, so React packages document themselves for
humans and agents alike.
> **Doc model:** this wiki is written for humans — guides and conventions. The
> authoritative API contracts live in the code (JSDoc) and the machine-readable
> bundle under `docs/mcp/`.
---
## 🚀 Key Features
- 🧵 JSDoc extraction via TypeDoc (the TypeScript compiler API)
- 🧬 doc-forge-compatible MCP bundle (`index.json`, `nav.json`, `modules/*.json`)
- ⚛️ React-aware kinds — `component` (PascalCase) and `hook` (`use*`)
- 📚 RDFC (React Doc-forge Convention) — the JSDoc parallel to GSDFC
- 🔌 MCP server over stdio exposing `docs://index`, `docs://nav`, and
`docs://modules/{module}`
---
## 📦 Installation
```bash
npm install
npm run build
```
This produces the `doc-weaver` binary under `bin/` and `dist/`.
---
## 📁 Documentation Structure
| Section | Description |
|-----------------------------------------|------------------------------------------------|
| [Overview](01_overview.md) | What doc-weaver is and how it fits |
| [RDFC Guide](02_rdfc.md) | How to write RDFC-conformant JSDoc |
---
## 🔗 Related Resources
- **Source Code:** the `doc-weaver` repository
- **MCP Bundle:** generated by `doc-weaver build --mcp --module src/index.ts`
into `docs/mcp/`
- **Library Registry:** registered in the standards hub as `doc-weaver`
(MCP `:8010`)
---
© Aetoskia Internal — `doc-weaver` 0.1.0