doc-weaver init and cross wiki-lib links fixes
Some checks reported errors
continuous-integration/drone/push Build was killed
Some checks reported errors
continuous-integration/drone/push Build was killed
This commit is contained in:
@@ -820,6 +820,13 @@ can read a library's full API by connecting to its MCP and reading
|
||||
<td><code>:8001</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Doc Weaver</td>
|
||||
<td><code>doc-weaver</code></td>
|
||||
<td>JSDoc compiler → TypeDoc + MCP docs (React/TS)</td>
|
||||
<td>custom TypeScript doc generators</td>
|
||||
<td><code>:8010</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Auth Server</td>
|
||||
<td><em>(service)</em></td>
|
||||
<td>Central identity service (register/login/me/logout/introspect)</td>
|
||||
@@ -869,6 +876,10 @@ can read a library's full API by connecting to its MCP and reading
|
||||
<td>generate documentation</td>
|
||||
<td>Doc Forge</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>generate React/TypeScript documentation</td>
|
||||
<td>Doc Weaver</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="discovery">Discovery</h2>
|
||||
@@ -888,6 +899,10 @@ any infrastructure.</p>
|
||||
via <code>docs://spec</code> and wire it by declaring a <code>bearerAuth</code> security scheme in
|
||||
the app's own spec (see <strong>Auth Integration</strong>); <code>py-jwt</code> covers the
|
||||
low-level token path.</li>
|
||||
<li><strong>Doc Weaver</strong> is the TypeScript counterpart to <strong>Doc Forge</strong>: it reads
|
||||
JSDoc comments and emits a TypeDoc site plus the same doc-forge-shaped MCP
|
||||
bundle for React packages. Its convention is <strong>RDFC</strong> (the React Doc-forge
|
||||
Convention), the JSDoc parallel to GSDFC.</li>
|
||||
<li>Library MCP servers expose <strong>documentation resources</strong> (not executable tools):
|
||||
they tell an agent the available API surface so it does not invent code.</li>
|
||||
</ul>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -66,6 +66,14 @@
|
||||
"capabilities": ["docs", "documentation", "mkdocs", "mcp", "docstrings", "gsdfc"],
|
||||
"mcp": { "server": "docforge", "port": 8001 }
|
||||
},
|
||||
{
|
||||
"name": "Doc Weaver",
|
||||
"import": "doc-weaver",
|
||||
"purpose": "TypeScript/JSDoc compiler that renders React documentation for humans (TypeDoc) and machines (MCP).",
|
||||
"use_instead_of": "custom TypeScript documentation generators",
|
||||
"capabilities": ["docs", "documentation", "typedoc", "mcp", "jsdoc", "rdfc", "react", "typescript"],
|
||||
"mcp": { "server": "doc-weaver", "port": 8010 }
|
||||
},
|
||||
{
|
||||
"name": "Auth Server",
|
||||
"import": null,
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"module": "library_registry",
|
||||
"content": {
|
||||
"path": "library_registry",
|
||||
"docstring": "# Library Registry\n\n## Summary\n\nThe Aetos ecosystem provides internal libraries for the shared concerns of\nevery application. **Use them.** Writing a private copy of any capability below\nis a defect.\n\nEach library also exposes its own documentation as an MCP server. An AI agent\ncan read a library's full API by connecting to its MCP and reading\n`docs://index`, `docs://nav`, and `docs://modules/{module}`.\n\n---\n\n## Catalog\n\n| Library | Import | Purpose | Use instead of | MCP |\n|---|---|---|---|---|\n| DAG Pipe | `dagpipe` | Deterministic state-transformation DAG engine | hand-rolled orchestration/topological ordering | `:8006` |\n| Hexa | `hexa` | Declarative DI / composition-root tooling | manual wiring, hand-written factories | `:8008` |\n| Mongo Ops | `mongo_ops` | Async MongoDB repositories, cache, populate, transactions | raw Motor CRUD and connection lifecycle | `:8007` |\n| Omniread | `omniread` | Format-agnostic fetch + parse (HTML, PDF, CSV, XLSX) | custom scrapers/parsers | `:8003` |\n| OpenAPI First | `openapi_first` | Spec-first FastAPI bootstrap, client, codegen | decorator routers and hand-written clients | `:8004` |\n| Mail Intake | `mail_intake` | Provider-agnostic read-only email ingestion | Gmail OAuth + MIME parsing | `:8002` |\n| Py JWT | `jwtlib` | JWT auth primitives (register/login/introspect) | password hashing + token code | `:8005` |\n| Doc Forge | `docforge` | Docstring compiler → MkDocs + MCP docs | custom doc generators | `:8001` |\n| Auth Server | *(service)* | Central identity service (register/login/me/logout/introspect) | building auth endpoints yourself | spec: `docs://spec` |\n\n## How to choose\n\n| You need to… | Use |\n|---|---|\n| persist and query documents | Mongo Ops |\n| compose dependencies | Hexa |\n| run a multi-step transformation | DAG Pipe |\n| read/parse an arbitrary input format | Omniread |\n| expose a contract-first HTTP API | OpenAPI First |\n| ingest email | Mail Intake |\n| authenticate users / verify tokens | Py JWT (+ Auth Server) |\n| generate documentation | Doc Forge |\n\n## Discovery\n\nA single **standards MCP** exposes `find_library(capability)`, which returns the\nmatching library, its import name, its \"use instead of\" guidance, and its MCP\nendpoint (or, for the auth-server service, a spec pointer). It also serves the\npinned auth-server OpenAPI contract at `docs://spec`. Query it before writing\nany infrastructure.\n\n## Notes\n\n- **Hexa** is a full library with its own MCP server on `:8008`: read\n `docs://index`, `docs://nav`, and `docs://modules/{module}` (e.g.\n `docs://modules/hexa.container`) to discover the DI surface — `build(cls, *,\n instances, config)` and the `PortNode` model.\n- **Auth Server** is a **service**, not an importable library: it has no MCP\n bundle by design. Read its client contract from the pinned OpenAPI document\n via `docs://spec` and wire it by declaring a `bearerAuth` security scheme in\n the app's own spec (see **Auth Integration**); `py-jwt` covers the\n low-level token path.\n- Library MCP servers expose **documentation resources** (not executable tools):\n they tell an agent the available API surface so it does not invent code.\n",
|
||||
"docstring": "# Library Registry\n\n## Summary\n\nThe Aetos ecosystem provides internal libraries for the shared concerns of\nevery application. **Use them.** Writing a private copy of any capability below\nis a defect.\n\nEach library also exposes its own documentation as an MCP server. An AI agent\ncan read a library's full API by connecting to its MCP and reading\n`docs://index`, `docs://nav`, and `docs://modules/{module}`.\n\n---\n\n## Catalog\n\n| Library | Import | Purpose | Use instead of | MCP |\n|---|---|---|---|---|\n| DAG Pipe | `dagpipe` | Deterministic state-transformation DAG engine | hand-rolled orchestration/topological ordering | `:8006` |\n| Hexa | `hexa` | Declarative DI / composition-root tooling | manual wiring, hand-written factories | `:8008` |\n| Mongo Ops | `mongo_ops` | Async MongoDB repositories, cache, populate, transactions | raw Motor CRUD and connection lifecycle | `:8007` |\n| Omniread | `omniread` | Format-agnostic fetch + parse (HTML, PDF, CSV, XLSX) | custom scrapers/parsers | `:8003` |\n| OpenAPI First | `openapi_first` | Spec-first FastAPI bootstrap, client, codegen | decorator routers and hand-written clients | `:8004` |\n| Mail Intake | `mail_intake` | Provider-agnostic read-only email ingestion | Gmail OAuth + MIME parsing | `:8002` |\n| Py JWT | `jwtlib` | JWT auth primitives (register/login/introspect) | password hashing + token code | `:8005` |\n| Doc Forge | `docforge` | Docstring compiler → MkDocs + MCP docs | custom doc generators | `:8001` |\n| Doc Weaver | `doc-weaver` | JSDoc compiler → TypeDoc + MCP docs (React/TS) | custom TypeScript doc generators | `:8010` |\n| Auth Server | *(service)* | Central identity service (register/login/me/logout/introspect) | building auth endpoints yourself | spec: `docs://spec` |\n\n## How to choose\n\n| You need to… | Use |\n|---|---|\n| persist and query documents | Mongo Ops |\n| compose dependencies | Hexa |\n| run a multi-step transformation | DAG Pipe |\n| read/parse an arbitrary input format | Omniread |\n| expose a contract-first HTTP API | OpenAPI First |\n| ingest email | Mail Intake |\n| authenticate users / verify tokens | Py JWT (+ Auth Server) |\n| generate documentation | Doc Forge |\n| generate React/TypeScript documentation | Doc Weaver |\n\n## Discovery\n\nA single **standards MCP** exposes `find_library(capability)`, which returns the\nmatching library, its import name, its \"use instead of\" guidance, and its MCP\nendpoint (or, for the auth-server service, a spec pointer). It also serves the\npinned auth-server OpenAPI contract at `docs://spec`. Query it before writing\nany infrastructure.\n\n## Notes\n\n- **Hexa** is a full library with its own MCP server on `:8008`: read\n `docs://index`, `docs://nav`, and `docs://modules/{module}` (e.g.\n `docs://modules/hexa.container`) to discover the DI surface — `build(cls, *,\n instances, config)` and the `PortNode` model.\n- **Auth Server** is a **service**, not an importable library: it has no MCP\n bundle by design. Read its client contract from the pinned OpenAPI document\n via `docs://spec` and wire it by declaring a `bearerAuth` security scheme in\n the app's own spec (see **Auth Integration**); `py-jwt` covers the\n low-level token path.\n- **Doc Weaver** is the TypeScript counterpart to **Doc Forge**: it reads\n JSDoc comments and emits a TypeDoc site plus the same doc-forge-shaped MCP\n bundle for React packages. Its convention is **RDFC** (the React Doc-forge\n Convention), the JSDoc parallel to GSDFC.\n- Library MCP servers expose **documentation resources** (not executable tools):\n they tell an agent the available API surface so it does not invent code.\n",
|
||||
"objects": {}
|
||||
}
|
||||
}
|
||||
@@ -24,6 +24,7 @@ can read a library's full API by connecting to its MCP and reading
|
||||
| Mail Intake | `mail_intake` | Provider-agnostic read-only email ingestion | Gmail OAuth + MIME parsing | `:8002` |
|
||||
| Py JWT | `jwtlib` | JWT auth primitives (register/login/introspect) | password hashing + token code | `:8005` |
|
||||
| Doc Forge | `docforge` | Docstring compiler → MkDocs + MCP docs | custom doc generators | `:8001` |
|
||||
| Doc Weaver | `doc-weaver` | JSDoc compiler → TypeDoc + MCP docs (React/TS) | custom TypeScript doc generators | `:8010` |
|
||||
| Auth Server | *(service)* | Central identity service (register/login/me/logout/introspect) | building auth endpoints yourself | spec: `docs://spec` |
|
||||
|
||||
## How to choose
|
||||
@@ -38,6 +39,7 @@ can read a library's full API by connecting to its MCP and reading
|
||||
| ingest email | Mail Intake |
|
||||
| authenticate users / verify tokens | Py JWT (+ Auth Server) |
|
||||
| generate documentation | Doc Forge |
|
||||
| generate React/TypeScript documentation | Doc Weaver |
|
||||
|
||||
## Discovery
|
||||
|
||||
@@ -58,5 +60,9 @@ any infrastructure.
|
||||
via `docs://spec` and wire it by declaring a `bearerAuth` security scheme in
|
||||
the app's own spec (see **Auth Integration**); `py-jwt` covers the
|
||||
low-level token path.
|
||||
- **Doc Weaver** is the TypeScript counterpart to **Doc Forge**: it reads
|
||||
JSDoc comments and emits a TypeDoc site plus the same doc-forge-shaped MCP
|
||||
bundle for React packages. Its convention is **RDFC** (the React Doc-forge
|
||||
Convention), the JSDoc parallel to GSDFC.
|
||||
- Library MCP servers expose **documentation resources** (not executable tools):
|
||||
they tell an agent the available API surface so it does not invent code.
|
||||
|
||||
Reference in New Issue
Block a user