Port the participant help articles into the Mintlify docs - #110
Merged
Conversation
The 17 participant guides lived in a separate Astro Starlight site. Move them into docs/ so there is one docs build, one deploy, and one URL. The prose needed almost nothing — no ::: asides, one table, no raw HTML. What changed is the Starlight-specific scaffolding around it: sidebar.order in frontmatter gives way to docs.json ordering, page-relative image paths become content-root paths, Starlight's trailing-slash internal links lose the slash, and the nine one-line blockquotes become real callouts. The 911 advice and the under-18 note on public profiles are Warnings, the wallet-pass one a Tip, the rest Notes. index.mdx becomes the help landing page, carrying over the Starlight hero's four cards. The old API landing page moves to api-introduction.mdx under an API reference tab, so Help and API are siblings rather than one buried in the other. Vale now covers .mdx, which is where the reader-facing prose actually lives. Its Microsoft style fights that voice on four rules, so those are switched off for docs/participants only, with the reasoning in .vale.ini: the FAQ headings are the reader's own words, we answer as people, "click" is what the web app means, and questions end in question marks. The rest of the repo keeps the full style. Nine words from the articles join the vocabulary. Findings across docs/ go from 83 to 10, and the ten left are real. Every screenshot is the seeded demo account — june.demo@example.com, a 555 number, Mock Summit 2025 — checked before committing, since this repo is public and the articles show health, guardian and profile screens. Claude-Session: https://claude.ai/code/session_01PtsTSgKVNFXJiUEErUbA6h
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Moves the 17 participant guides out of the separate Astro Starlight site (
~/code/attend-docs) and intodocs/, so there's one docs build, one deploy, and one URL.What actually needed converting
The prose was clean — no
:::asides, one table, no raw HTML. It was the Starlight scaffolding around it that had to change:sidebar: order:in frontmatterdocs.json](images/foo.png)(page-relative)](/participants/images/foo.png)(content-root)](/participants/x/)](/participants/x)> **Q?** A.blockquotes<Note>/<Tip>/<Warning>template: splash+<CardGrid><Columns>+<Card href>The nine blockquotes were graded rather than blanket-converted: the 911 advice and the under-18 note on public profiles are
<Warning>, the "add your wallet pass before you travel" one is<Tip>, the rest are<Note>.Structure
index.mdxbecomes the help landing page, carrying over the four cards from the Starlight hero. The old API landing page moves toapi-introduction.mdxunder its own API reference tab, so Help and API sit as siblings instead of one being buried under the other.I verified every navigation entry resolves to a file, every content file appears in navigation, every image link resolves, and no Starlight syntax survived.
Vale
Vale only covered
[*.md], so it was skipping the most reader-facing prose in the repo. It now covers.mdxtoo.Its Microsoft style fights this voice on four rules, so those are off for
docs/participantsonly — the rest of the repo keeps the full style — with the reasoning written into.vale.ini:Nine words from the articles (
autosave,Bluesky,dropoff,headshot,superadmin,unsubmitted,wifi…) join the vocabulary. Findings acrossdocs/drop from 83 to 10, and the ten that remain are real prose nits rather than noise.Also removes the now-dead
[docs/superpowers/**]exclusion — that directory went away in #109.Screenshots
All 20 are the seeded demo account —
june.demo@example.com, a555number, "Mock Summit 2025", "Juniper Reyes". I checked them before committing rather than after, since this repo is public and the articles show health, guardian-consent and profile screens.https://claude.ai/code/session_01PtsTSgKVNFXJiUEErUbA6h