ascii-chat-documentation
Skill203 starsChanged 8 days agoMITView on GitHub
Work on ascii-chat's Doxygen topics, authored guides, navigation, and generated documentation.
In this repository11 other files it gives its agents.
- web/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- ascii-chat-c-developmentSkill
- ascii-chat-cli-releaseSkill
- ascii-chat-cross-platform-development-and-or-testingSkill
- ascii-chat-mcp-devSkill
- ascii-chat-python-developmentSkill
- ascii-chat-testingSkill
- ascii-chat-wasm-developmentSkill
- ascii-chat-web-deploySkill
- sentry-commit-messagesSkill
The file
We split this skill into the rules it gives an agent
3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 27
Before changing a public API, subsystem, transport, option, screen, or workflow, inspect the existing Topics and update or create the …
- Very specific: line 38
Verify with the docs-only project in docs/CMakeLists.txt:
- Distinctive: line 45
Check generated HTML for broken links, topic placement, and stale claims before committing.
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
ascii-chat documentation workflow
ascii-chat documentation is generated by Doxygen from three complementary inputs:
- Source comments and headers provide API, file, type, and symbol reference pages.
docs/topics/*.doxprovides the authored, rendered Topics pages for architecture, ownership, protocols, subsystems, and developer workflows.
docs/topics/index.dox defines Topic Categories, while docs/topics.dox
defines Topics. Put durable subsystem documentation in both indexes when it
belongs in the curated navigation. Documentation work is welcome and
encouraged, but do not create random Markdown files under docs/: if a page
is not wired into Doxygen it will not be rendered or discoverable in the
browser. Write new documentation as a .dox Topic and add it to the relevant
section of docs/topics/index.dox when appropriate. Modify existing rendered
documentation freely when it improves the site.
Before changing a public API, subsystem, transport, option, screen, or
workflow, inspect the existing Topics and update or create the relevant .dox
page in the same change. Keep related Topics cross-linked and do not copy
stale implementation claims between them.
The generated site is built by the standalone CMake project in
docs/CMakeLists.txt. It configures Doxygen without configuring or compiling
the native application and writes the HTML under the selected build directory.
The repository's documentation workflow builds this project and deploys its
HTML artifact to GitHub Pages after a successful build.
Verify with the docs-only project in docs/CMakeLists.txt:
cmake -S docs -B build/docs-standalone -DASCII_CHAT_SOURCE_DIR=$PWD
cmake --build build/docs-standalone --target docsCheck generated HTML for broken links, topic placement, and stale claims before committing. Verify the hosted page after documentation deployment completes.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

