Guide

Write entries that are easy to scan and easy to trust.

Keep each entry practical. Focus on where it fits, where it fails, and the trade-offs that matter.

Workflow

1. Open a category or click Add Entry.
2. Pick the most accurate category first.
3. Fill title, description, and trade-off fields.
4. Save and refine later as your understanding improves.

Current Template

Required

Title
Description
Category
When to use
Pros
Cons

Optional

Notes

Use Notes for links, caveats, and team conventions.

Field Guide

Field	Required	What to write
Title	Yes	Specific name that is easy to search later.
Description	Yes	One or two lines of plain summary.
Category	Yes	Choose the best-fit lane for navigation.
When to use	Yes	Include use cases and avoid cases.
Pros	Yes	Bullet list of clear benefits.
Cons	Yes	Bullet list of limits and costs.
Notes	No	Links, migration caveats, and extra context.

Markdown

**bold**

Bold text

Highlight key words

`code`

Inline code

Commands, APIs, config keys

- item

Bullet list

Best for pros/cons

1. item

Numbered list

Ordered steps

[text](url)

Link

Reference docs and specs

```ts code ```

Code block

Use in notes when needed

Writing Rules

Good

When to use
- Use in data-heavy pages with repeated API calls.
- Avoid when data is static at build time.

Pros
- Better cache reuse across screens.
- Reduces duplicate request logic.

Avoid

When to use
Sometimes.

Pros
It is good.

Workflow

1. Open a category or click Add Entry.
2. Pick the most accurate category first.
3. Fill title, description, and trade-off fields.
4. Save and refine later as your understanding improves.

Current Template

Required

Title
Description
Category
When to use
Pros
Cons

Optional

Notes

Use Notes for links, caveats, and team conventions.

Field Guide

Field	Required	What to write
Title	Yes	Specific name that is easy to search later.
Description	Yes	One or two lines of plain summary.
Category	Yes	Choose the best-fit lane for navigation.
When to use	Yes	Include use cases and avoid cases.
Pros	Yes	Bullet list of clear benefits.
Cons	Yes	Bullet list of limits and costs.
Notes	No	Links, migration caveats, and extra context.

Markdown

**bold**

Bold text

Highlight key words

`code`

Inline code

Commands, APIs, config keys

- item

Bullet list

Best for pros/cons

1. item

Numbered list

Ordered steps

[text](url)

Link

Reference docs and specs

```ts code ```

Code block

Use in notes when needed

Writing Rules

Good

When to use
- Use in data-heavy pages with repeated API calls.
- Avoid when data is static at build time.

Pros
- Better cache reuse across screens.
- Reduces duplicate request logic.

Avoid

When to use
Sometimes.

Pros
It is good.

Write entries that are easy to scan and easy to trust.

Workflow

Current Template

Field Guide

Markdown

Writing Rules

Categories

Write entries that are easy to scan and easy to trust.

Workflow

Current Template

Field Guide

Markdown

Writing Rules

Categories