agentleFS
marslomarslo/skills/.cursor/rules/markdown-style.mdc

skills / rules

Cursor rule0 starsChanged 2 months agoMITView on GitHub

Markdown writing conventions for marslo

The file

We split this markdown-style.mdc into the rules it gives an agent

4 rules. About 0 are common, 4 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Results / focus only: No narration, no filler, no restating the obvious.

    line 14
  2. Distinctive:

    Prefer tables / code / lists over prose: If a table or code block conveys it, don't write a paragraph.

    line 15
  3. Distinctive:

    Comment code sparingly: Add short inline comments only where a snippet isn't self-evident.

    line 16
  4. Distinctive:

    No 80-column wrapping: Don't hard-wrap prose to guess an 80-char width.

    line 17

≈ “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
markdown-style.mdc
---
description: Markdown writing conventions for marslo
globs: **/*.md
alwaysApply: false
---

# Markdown Style

Concise, scannable Markdown. Describe **what / how**; skip **why / rationale**.

## Rules

- **What & how, not why.** State the result / step / key point. Drop background and rationale. Only if the logic is genuinely complex, add 1–2 lines of explanation — no more.
- **Results / focus only.** No narration, no filler, no restating the obvious.
- **Prefer tables / code / lists over prose.** If a table or code block conveys it, don't write a paragraph.
- **Comment code sparingly.** Add short inline comments only where a snippet isn't self-evident; keep them terse.
- **No 80-column wrapping.** Don't hard-wrap prose to guess an 80-char width. Break lines by logic / context (one idea per line); let the line run as long as it reads naturally.
- **Use GitHub callouts** for emphasis / tips / references — not bold prose (**files only**, **never in use chat/agent/assistant replies**). :

  | callout | use for |
  |---|---|
  | `> [!NOTE]` | context / reference |
  | `> [!TIP]` | optional advice |
  | `> [!IMPORTANT]` | must-know |
  | `> [!WARNING]` | gotcha / risk |
  | `> [!CAUTION]` | danger / data loss |

  Scope — **files only**: use callouts **only** when writing or editing an actual Markdown document/file (`*.md`, README, docs, etc.). In chat / assistant replies, **never** use `> [!NOTE]` / `> [!TIP]` etc. — even though the reply is rendered as Markdown, callout syntax is for files, not conversation.

## Prefer

```diff
- Because the cache can grow without bound on long-running hosts and eventually
- cause memory pressure, you should periodically call `.clear()`, which frees the
- backing store so that ...
+ Call `.clear()` periodically to cap memory.
```

> [!TIP]
> One idea per line. If you're explaining *why*, cut it.

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.