agentleFS
factor241factor241/ketos-bot/.cursor/rules/docs_development.mdc

ketos-bot / rules

Cursor rule1 starsChanged 2 months agoMITView on GitHub

Maintain the current Ketos Docusaurus manual and examples.

  • Reads credentials

The file

We split this docs_development.mdc into the rules it gives an agent

2 rules. About 0 are common, 1 is distinctive, and 1 is 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.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Do not add upstream release history, community promotion, external OpenAPI fetches, unverified deployment instructions, or screenshots from …

    line 20
  2. Very specific:

    Every page has title and slug frontmatter.

    line 25

≈ “Common” is an estimate: at least 1 in 5 of the 6,668 Cursor rule 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
docs_development.mdc
---
description: "Maintain the current Ketos Docusaurus manual and examples."
globs:
  - "docs/**/*.{md,mdx}"
  - "docs/**/*.{js,jsx,ts,tsx}"
  - "docs/package.json"
  - "docs/docusaurus.config.js"
  - "docs/sidebars.js"
alwaysApply: false
---

# Ketos documentation

The published manual is `docs/docs`; `docs/sidebars.js` is its explicit route
inventory. Use only verified current behavior, `ketos` and `kfx` commands,
`KETOS_*` and `KFX_*` settings, `x-api-key: ${KETOS_API_KEY}` for API keys,
`Authorization: Bearer` only for JWT/OAuth tokens, and `X-KETOS-GLOBAL-VAR-*`
request variables.

Do not add upstream release history, community promotion, external OpenAPI
fetches, unverified deployment instructions, or screenshots from another
product. Retained media must be a canonical asset under `brand/assets/generated`
or a new Ketos capture with recorded OCR review.

Every page has `title` and `slug` frontmatter. Use relative links for manual
pages and fenced executable examples. Verify with:

```bash
cd docs
npm run check:links
npm run build
make api_examples_local_syntax
make api_examples_local
```

Generated OpenAPI JSON is not edited by hand. The only source generator is
`docs/openapi/generate_openapi.py`, which imports the local application.

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.