docs(docs): clarify phase-based content paths and frontmatter ownership in documentation

This commit is contained in:
Prad Nukala committed 2026-09-28 11:20:55 -04:00
1 parent d2888360e2
commit 951f958bd9
2 files changed
+10 -11

No files matched your search

+5 -6
View File
@@ -5,14 +5,13 @@ description: Write the `## Approach` section — a Mermaid flowchart that traces
# Problem approach diagrams
Every solution page (`apps/docs/content/(<category>)/<num>-<slug>.mdx`) has three
hand-owned sections around the script-owned one:
Every solution page (`apps/docs/content/(<phase>)/<topic>/<num>-<slug>.mdx`) has a
hand-owned section before the script-owned one:
```
frontmatter → <Badge> → ::::warning (maybe) → ### Example N / ### Constraints
frontmatter → ::::warning (maybe) → ### Example N / ### Constraints
## Approach ← this skill (Mermaid flowchart of the code below)
## Solution ← bun run sync owns this; never edit inside it
## Explanation ← bun run videos --write (NeetCode embed); not this skill
```
`sync.ts` regenerates only `## Solution`, so an `## Approach` placed **before** it
@@ -144,7 +143,7 @@ there (then `bun run sync`).
- Do not write prose approaches, complexity tables or alternative algorithms — the
section is one flowchart (plus the warning callout when the code is broken).
- Do not touch `## Solution` or anything after it; `## Explanation` is filled by
`bun run videos --write`.
- Do not touch `## Solution` or anything after it, nor the frontmatter `topics:` /
`video:` keys (`bun run sync` / `bun run videos --write` own them).
- Do not add an approach to `reference/` pages or `index.mdx` — only numbered
solution pages (`title: 'NN. …'`) carry one.