docs(cli): clarify badge rendering uses MDX wrapper instead of PageHeader slot

This commit is contained in:
Prad Nukala committed 2026-09-29 17:03:25 -04:00
1 parent 6f1cb93395
commit 2f94b02e15
2 files changed
+4 -4

No files matched your search

+3 -3
View File
@@ -15,9 +15,9 @@
* `topicTags` once — when the page is created, or on any later run that * `topicTags` once — when the page is created, or on any later run that
* finds the key missing — and never refreshed after, so a sync with nothing * finds the key missing — and never refreshed after, so a sync with nothing
* new makes no request. Delete the key to refetch it. The page itself * new makes no request. Delete the key to refetch it. The page itself
* renders no badges: the docs `PageHeader` slot * renders no badges: the docs MDX `wrapper`
* (`apps/docs/components/ProblemBadges.astro`) turns `topics:` and the * (`apps/docs/components/ProblemBadges.astro`) turns `topics:` and the
* `video:` key `videos.ts` writes into the badge row above the title. * `video:` key `videos.ts` writes into the badge row under the description.
* - Every tag a page carries that no campaign topic teaches (not a key of * - Every tag a page carries that no campaign topic teaches (not a key of
* `apps/docs/topic-landings.ts`) gets a placeholder guide page, * `apps/docs/topic-landings.ts`) gets a placeholder guide page,
* `guides/<slug>.mdx`, with `list:` pointing at LeetCode's problem list for * `guides/<slug>.mdx`, with `list:` pointing at LeetCode's problem list for
@@ -400,7 +400,7 @@ function frontmatterTopics(page: string): TopicTag[] {
/** /**
* Placeholder for a tag no campaign topic teaches: the `/guides/<slug>` page a * Placeholder for a tag no campaign topic teaches: the `/guides/<slug>` page a
* problem's topic badge links to. `list:` is the tag's LeetCode problem list, * problem's topic badge links to. `list:` is the tag's LeetCode problem list,
* rendered as a badge by the docs `PageHeader` slot. Written once — the page * rendered as a badge by the docs MDX `wrapper`. Written once — the page
* is hand-owned from then on. * is hand-owned from then on.
*/ */
function guidePage(tag: TopicTag): string { function guidePage(tag: TopicTag): string {
+1 -1
View File
@@ -3,7 +3,7 @@
* Find the NeetCode explanation video for every docs page that has none. * Find the NeetCode explanation video for every docs page that has none.
* *
* A finished solution page carries frontmatter `video: <YouTube id>` — * A finished solution page carries frontmatter `video: <YouTube id>` —
* NeetCode's walkthrough of the problem — which the docs `PageHeader` slot * NeetCode's walkthrough of the problem — which the docs MDX `wrapper`
* (`apps/docs/components/ProblemBadges.astro`) renders as the red * (`apps/docs/components/ProblemBadges.astro`) renders as the red
* "Explanation" badge beside the topic badges. `sync.ts` never writes that key * "Explanation" badge beside the topic badges. `sync.ts` never writes that key
* (it owns `icon:`, `topics:` and `## Solution`), so pages accumulate without * (it owns `icon:`, `topics:` and `## Solution`), so pages accumulate without