docs

A documentation layout and writing guide for LogosDX packages. It defines the sections, tone, and style expected in package documentation for busy developers.

In plain words
What is it for?
It guides writers in organizing package pages, explaining core concepts, choosing direct language, avoiding hype, and documenting trade-offs.
Why use it?
It helps keep package documentation consistent, brief, and understandable instead of leaving structure and wording to individual authors.

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/logosdx/monorepo/docs
Clone the repo
git clone --depth 1 https://github.com/logosdx/monorepo

Made for: Cursor.

Per session 8 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,022 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.00008 $0.01022
Opus 5 $0.00004 $0.00511
Sonnet 5 $0.00002 $0.00204
Haiku 4.5 $0.00001 $0.00102

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

Security

Grade A, and why

docs 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/docs.mdc · 195 lines

How it starts

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

📘 Documentation Meta Layout for LogosDX Packages

Each package should have a single file written for a competent but time-starved developer. Prioritize clarity, brevity, and usefulness. Avoid hype language and unnecessary verbosity.


✍️ Tone and Style Guidelines

Personality:

  • Calm, clear, senior-dev energy.
  • Witty is fine. Condescending is not.
  • Be opinionated where it helps. Justify trade-offs.

Avoid:

  • Overused buzzwords like robust, intuitive, powerful, comprehensive
  • Passive voice
  • Words like simply, just, or seamlessly

Prefer:

  • Direct sentences
  • Honest tradeoffs (“This works well unless you’re doing X.”)
  • Short paragraphs, meaningful whitespace, and real-world language

🧱 Sections and Their Purpose

Each doc file should follow this structure (some sections can be optional depending on the package):


1. # Package Name

One-liner summary of what this package does and why it exists.

Keep it human:

“Declarative retry, timeout, and error flow for async JavaScript. Works everywhere. No ceremony.”


2. ## Core Concepts (Required)

A short explanation of the package’s mental model.

  • What problem does it solve?
  • How does it fit the LogosDX philosophy? (e.g., structure over scaffolding)
  • How is it different from what developers might already be using?

3. ## Quick Start (Required)

Show how to install and use it in under 10 lines.

  • Installation command
  • A real (but minimal) usage snippet
  • Zero explanation unless it's essential — this is a “see for yourself” moment

4. ## API Overview (Required)

List of exported utilities, components, or functions with short 1–2 sentence blurbs.

Can be a list or table like:

- `attempt(fn)`: Wraps sync or async logic and returns [result, error]
- `retry(fn, opts)`: Retries a function N times before failing

5. ## Usage (Required)

Detailed explanations and examples for each export.

Each utility/function/module gets a heading:

Read the full file on GitHub · 195 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 · 195 lines · 8 tokens per session scan A 17039858d93b

Subscribe to this mod's changes

docs is a cursor rule published in the GitHub repository logosdx/monorepo (7 stars, last pushed 16d ago), licensed BSD-3-Clause. It adds 8 tokens to every session and 1,022 once invoked, about $0.0000 per session on Opus 5. 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.