docs(wiki): added more rules and explanation on how to use the prompt in docforge wiki
This commit is contained in:
@@ -47,14 +47,19 @@ pip install docforge
|
||||
|
||||
- **Source Code:** the `doc-forge` repository
|
||||
- **MCP Bundle:** generated by `doc-forge build --mcp --module docforge` into `docs/mcp/`
|
||||
- **Wiki Kind:** hand-written content lives in `docs/wiki/` or use the prompt mentioned below
|
||||
- **Wiki Kind:** hand-written content lives in `docs/wiki/`; use the prompt in the
|
||||
wiki-related resource below
|
||||
````markdown
|
||||
# AGENTS.md — Wiki Authoring Guide (Aetoskia)
|
||||
|
||||
This file instructs AI agents how to create, extend, and maintain the wiki
|
||||
(`docs/wiki/**`) for any Aetoskia repository. The reference implementation is
|
||||
`mongo-ops` — its wiki went through several revisions to reach the structure
|
||||
below and should be treated as the canonical example.
|
||||
(`docs/wiki/**`) for any Aetoskia repository.
|
||||
|
||||
> **Workflow:** this prompt covers **phase 2 only**. Phase 1 — writing GSDFC docstrings
|
||||
> (plus `.pyi` stubs and `py.typed`) — is done by the agent using the doc-forge MCP
|
||||
> bundle: `doc://modules/docforge` carries the full GSDFC spec. Write the wiki only
|
||||
> after docstrings exist and `doc-forge build --mcp --module <pkg>` produced the
|
||||
> repo's own bundle.
|
||||
|
||||
---
|
||||
|
||||
@@ -261,6 +266,10 @@ Variants:
|
||||
- Keep pages focused: one recipe/purpose per page. If a page balloons past
|
||||
~10 KB, split it (add a numbered deep-dive page instead).
|
||||
- Match tone of existing pages in the repo before writing new ones.
|
||||
- Ground every `## 🚀 Example`, `💡 Tips`, and `📦 What's New?` row in the
|
||||
library's actual source, tests, and its `docs/mcp` bundle — never invent
|
||||
APIs or behavior. Signatures and exceptions come from the code; gotchas
|
||||
come from the tests.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user