documentation

A set of project rules for keeping documentation in defined folders and following a fixed order and catalogue structure. It also records which files are authoritative for different kinds of documentation.

In plain words
What is it for?
Use it when adding or updating PoolAI documentation, deciding where a document belongs, or checking documentation against the project and its public interface.
Why use it?
It prevents documents from being scattered in the wrong places or becoming inconsistent with the project’s documented structure.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/platinoff/poolai/documentation
Clone the repo
git clone --depth 1 https://github.com/platinoff/poolAI

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 1,660 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.01660
Opus 5 $0.00000 $0.00830
Sonnet 5 $0.00000 $0.00332
Haiku 4.5 $0.00000 $0.00166

Measured yesterday against content hash 7175859c217f, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/documentation.mdc · 147 lines

How it starts

The opening of the file, as written. The whole thing — 147 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation Structure Rules

Canonical documentation order (PoolAI)

Узгоджено з кореневим README.md (Documentation map): кроки 1–12. Останні кроки:

  • 11. docs/catalog/FUNCTIONALITY_DIGEST_2026-04-06.md — структурований витяг функціоналу (модулі, features, HTTP-шари). Оновлювати після значних змін у src/ або публічному API.
  • 12. docs/catalog/FUNCTION_MANAGEMENT.mdкерування функціоналом: звірка зі сталевим станом, прогалини, чернетки тікетів (FM-*), посилання на плани та концепти. Правило агента: .cursor/rules/functionality-management.mdc.

Каталог docs/catalog/ призначений для зведень і індексів, які не є «планом розробки» (docs/development/) і не «статусом» (docs/status/).

Project skill: .agents/skills/poolai-documentation/SKILL.md (mirrors: .cursor/skills/, .opencode/skills/) — стислі інструкції для агента з цього порядку та витягу.

Runtime stack: .cursor/rules/runtime-stack-policy.mdc — Rust primary; Python заборонено в продукті (архівні docs не канон).

Авторозробка: найновіший docs/development/AUTO_RUN_SESSION_*.md, реєстр патернів docs/development/AUTO_DEV_PATTERNS.md, правила .cursor/rules/autonomous-orchestrator.mdc та .cursor/rules/functionality-management.mdc.


📁 Documentation Structure - STRICT RULES

Human-readable taxonomy (Ukrainian): docs/STRUCTURE.md — canonical entry points, folder meanings, legacy flat files under docs/, Cursor rules, inventory.

⚠️ CRITICAL: All documentation MUST be in docs/ directory

NEVER create .md files in the root directory (except README.md and README.uk.md)

File Organization:

  • All documentation → docs/ directory
  • All Cursor rules → .cursor/rules/ directory
  • Dev/ops launchers → bin/; toolchain/deploy → scripts/; Rust CLIs → src/bin/ (see docs/development/REPOSITORY_LAYOUT.md)
  • Troubleshooting guides → docs/troubleshooting/

Directory Structure

When creating or referencing documentation, use this structure:

Read the full file on GitHub · 147 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 147 lines · 1,660 tokens per session scan A 7175859c217f

Subscribe to this mod's changes

documentation is a cursor rule published in the GitHub repository platinoff/poolAI (4 stars, last pushed 8d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,660 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.