Skip to the content.

Style Guide

The root README should be useful, neutral, and easy to scan. Keep teaching detail in docs.

Voice

Use a factual editorial voice.

Prefer:

Avoid:

Entry Format

Player entries should use:

### Name

One or two sentences explaining why this person belongs.

- [Primary source](https://example.com/)
- [Study resource](https://example.com/)

Framework entries should use:

### Framework Name

Short definition. Explain when it is useful and what decision it helps with.

Resource entries should use:

- [Resource name](https://example.com/) - Clear description of what the reader gets.

Descriptions

Descriptions should answer one question: why should a serious student click this?

Keep them short. One sentence is usually enough. Two sentences are acceptable for historically important figures or regional context.

Prefer links in this order:

  1. Official source.
  2. Public archive.
  3. Book or publisher page.
  4. Public lecture, interview, or talk.
  5. High-quality secondary explanation.

Avoid affiliate links, tracking links, URL shorteners, and generic homepages when a more specific source exists.

Quotes

Use quotes sparingly. A quote should clarify a core idea, not decorate the entry. If a quote cannot be confidently sourced, summarize the idea instead.

Regional Labels

Use regional labels when they help readers understand market context:

### Name _(Brazil)_

The label is not a lower standard. Regional entries still need public references and a clear reason to belong.

Terminology

Use copywriting, direct response, sales letter, VSL, landing page, email sequence, and offer consistently. If a term may confuse beginners, define it in glossary.md.

Awesome List Fit

The README should remain an awesome list: