Buffaly wiki
Use the checked-in Buffaly wiki as the durable markdown home for source-backed knowledge, operational guidance, and reusable documentation work.
Wiki role
The Buffaly wiki is a markdown-backed documentation surface served by the Buffaly web host and wiki module. Use it for durable user-facing concepts, how-tos, operations notes, references, and extension guidance.
Optimized for checked-in knowledge
Articles are simple markdown-style files that Buffaly can inspect, diff, validate, and commit alongside implementation references.
Not a heavy CMS
Prefer focused generation, refresh, reconciliation, and reorganization of verified markdown over maintaining a separate publishing system.
Treat generated or staging documentation as migration input. The durable user-facing version belongs in the checked-in wiki or, when polished for the public site, in this docs section.
Where wiki content lives
The primary wiki root is under the Buffaly web content tree. Give Buffaly exact absolute paths when asking it to create or update wiki articles.
| Section | Use it for |
|---|---|
| core/ | Beginner, conceptual, and main user-guide pages. |
| operations/ | Operating, safety, sessions, troubleshooting, validation, and recovery pages. |
| reference/ | Deeper reference material and extension guidance. |
| catalog/ | Catalogs of skills, integrations, providers, and surfaces. |
Routes and UI surfaces
The wiki module exposes browser routes for reading and editing wiki pages, plus local-file helpers used by timelines and documentation links.
Wiki browser shell.
View a wiki article by slug.
Open the wiki editor shell.
Open local markdown; wiki-owned files can redirect to wiki routes.
The wiki service also supports typed operations to list articles, get or save an article, resolve a physical path to a wiki route, and search wiki articles.
Documentation generation workflow
Good wiki requests include the target path, audience, source material, validation steps, and commit expectation. Ask Buffaly to inspect sources first and stage only intended files.
- Resolve the absolute wiki path and repo-relative path before writing.
- Inspect implementation code, checked-in wiki pages, and relevant docs before making claims.
- Prefer improving an existing owner page over creating a duplicate article.
- Write for users first: explain what to do, what Buffaly does, how to verify, and where evidence lives.
- Preserve verified references and note exactly which files support important claims.
- Validate paths, links, scoped git status, and final commit contents.
Example request
"Improve the wiki article at the exact absolute path I provide. Inspect the relevant implementation and adjacent wiki pages first. Validate the file exists, stage only that article and directly necessary navigation, commit, and report the commit hash."
Verification checklist
Before declaring wiki work complete, verify concrete evidence rather than relying on a summary.
Troubleshooting wiki work
Article was written to the wrong folder
Check for files under a session directory or generated docs folder. Move or rewrite the article to the absolute wiki path.
Wiki page does not open
Verify the physical file, allowed extension, slug, wiki root, and route availability.
Article duplicates another page
Search the wiki first, merge useful verified content into the owner page, and cross-link instead of creating a parallel article.
Unrelated dirty files appear
Do not stage unrelated files. Commit only the wiki article and directly required navigation or index files for the assignment.