agentleFS
zfoggzfogg/ascii-chat/.agents/skills/ascii-chat-documentation/SKILL.md

ascii-chat-documentation

Skill203 starsChanged 8 days agoMITView on GitHub

Work on ascii-chat's Doxygen topics, authored guides, navigation, and generated documentation.

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
  1. Very specific:

    Before changing a public API, subsystem, transport, option, screen, or workflow, inspect the existing Topics and update or create the …

    line 27
  2. Very specific:

    Verify with the docs-only project in docs/CMakeLists.txt:

    line 38
  3. Distinctive:

    Check generated HTML for broken links, topic placement, and stale claims before committing.

    line 45

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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/*.dox provides 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 docs

Check generated HTML for broken links, topic placement, and stale claims before committing. Verify the hosted page after documentation deployment completes.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.