Skip to content

Group Guide TOC into Contents, Onboarding, Reference#290

Open
PunchTheDev wants to merge 1 commit into
mainfrom
punch/guide-toc-groups
Open

Group Guide TOC into Contents, Onboarding, Reference#290
PunchTheDev wants to merge 1 commit into
mainfrom
punch/guide-toc-groups

Conversation

@PunchTheDev
Copy link
Copy Markdown
Owner

Summary

Adds visual grouping to the Guide page sidebar TOC so a first-timer can tell sequential steps apart from reference material at a glance.

Motivation

The TOC was a flat 12-item list — Step 1–5 (sequential prerequisites) mixed with reference sections (Whitelisted models, API reference, How rewards work, Anti-gaming) with no visual distinction. A first-timer landing on /guide couldn't tell which items were the journey vs. background reading.

Changes

  • QuickstartGuide.tsx L271–290: TOC_ITEMS now a TocItem discriminated union ("heading" | "link"). Three group headers inserted inline: implicit top (just "Three categories"), Onboarding · 5 steps to your first submission, Reference.
  • QuickstartGuide.tsx L315–340: render path injects an uppercase heading + optional hint line + top-border separator when it encounters a heading item. Active-section highlighting (IntersectionObserver) and smooth-scroll click behavior unchanged.
  • BACKLOG.md L108: TOC / sticky nav flipped ○ ○ ○ → ● ● ● with a one-line rationale.

Screenshots

/tmp/guide-toc.png — sidebar TOC at 1440×900 showing the three groups with Onboarding hint copy and border separators between groups.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant