Vishesh 'ironeagle' Bangotra
aeb6e6b0f6
Some checks failed
continuous-integration/drone/tag Build is failing
TypeDoc + JSDoc (RDFC) compiler producing a TypeDoc site and a
doc-forge-shaped MCP bundle for React/TypeScript packages.
- TypeDoc loader + human-docs and MCP renderers, signature-level
parameter docs and default-export surfacing
- MCPServer over @modelcontextprotocol/sdk (docs://index, docs://nav,
docs://modules/{module}, ping tool)
- doc-weaver build / serve CLI
- RDFC convention guide and hand-written wiki
- packaged as @aetoskia/doc-weaver with an npm release pipeline
(build-and-publish-npm + backfill-npm-from-tags)
56 lines
1.7 KiB
Markdown
56 lines
1.7 KiB
Markdown
# 🪡 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
|