agentleFS
Sign inStart free
BuddhiliveBuddhilive/buddhi-cli/.agents/skills/document-codebase/SKILL.md

document-codebase

Skill1 starsChanged 13 days agoMITView on GitHub

Generate or refresh OKF codebase documentation under .buddhi/docs/, using buddhi's code graph and RepoAgent-style bottom-up doc generation. Use when updating or creating codebase docs with /document-codebase.

3 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

1 rule. 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 3 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run buddhi docs plan in the project root (use buddhi init instead if .buddhi/ or .agents/ don't exist yet).

    line 19

“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “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

/document-codebase

$ARGUMENTS

Generate or refresh this codebase's OKF documentation under .buddhi/docs/, using buddhi's code graph and the RepoAgent-style bottom-up doc-generation method.

Steps

  1. Run buddhi docs plan in the project root (use buddhi init instead if .buddhi/ or .agents/ don't exist yet). This refreshes .buddhi/docs-plan.json against the current source tree.
  2. Apply the repoagent-doc-generation skill: read the plan, process every entry with needs_generation: true in the order given, write each OKF concept doc, and update the affected index.md / log.md files.
  3. Build or preview the documentation portal: run buddhi docs build to compile the static site into .buddhi/site/, or run buddhi docs to serve the live portal with hot-reloading.
  4. Report a summary: how many entries were in the plan, how many were already current and skipped, and how many were (re)generated this run.

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.

Check your setup, free