Skip to content

feat(website): quickstart guide with hero hint and bottom CTA#185

Merged
montfort merged 2 commits into
mainfrom
feat/website-quickstart-guide
May 21, 2026
Merged

feat(website): quickstart guide with hero hint and bottom CTA#185
montfort merged 2 commits into
mainfrom
feat/website-quickstart-guide

Conversation

@montfort
Copy link
Copy Markdown
Contributor

Summary

Adds a standalone /quickstart page and two homepage surfaces that lead to it:

  • Hero hint — one subtle line under the install command: "…then follow our short quickstart guide →". Doesn't compete with the existing CTA buttons; just signals there's a guide.
  • Bottom "Ready to try it?" section — last section on the landing, single big CTA button to /quickstart. Targets the visitor who reached the bottom of the page without quitting.

The /quickstart page is one long MDX with six sections, designed for a developer who has decided to try the tool and wants the shortest end-to-end path:

  1. Install & verifycurl one-liner, straymark --version, update commands.
  2. Initialize your repostraymark init, the .straymark/ tree explained.
  3. Your first Charter — CLI flag and /straymark-charter-new skill, the four template sections.
  4. AILOG when you commit — when to write one, what goes in, commit-message convention.
  5. Status & validatestraymark status, straymark validate --staged, a two-line pre-commit hook.
  6. Run your first external audit — the 3-phase, 3-skill multi-model audit cycle.

~10–15 min of reading, heavy on copy-paste-able commands, deliberately not docs-depth. The right-side TOC is Docusaurus' native one.

Why

The site reads at two speeds: people who skim (Hero + workflow blueprint + features grid) and people who decide to try it (Hero install + this guide). Until now there was nothing for the second group — they had to land in the docs and assemble the happy path themselves. The guide is the missing bridge between "I'll try it" and "I have a closed Charter".

Asciinema demo is a separate, follow-up PR (different purpose: a "wow" surface for visitors who haven't decided yet).

i18n

  • The five new homepage strings (hero.quickstartHint, hero.quickstartHint.link, gettingStarted.title, gettingStarted.body, gettingStarted.cta) are translated to es and zh-CN.
  • The /quickstart.mdx page itself is English-only in this PR; Docusaurus falls back gracefully under /es/quickstart and /zh-CN/quickstart (visitor sees English content inside their localized chrome). Translation of the guide is a deliberate follow-up.

Test plan

  • npm run build succeeds for all three locales (verified locally — build/quickstart.html, build/es/quickstart.html, build/zh-CN/quickstart.html exist).
  • On /, /es/, /zh-CN/: hero shows the subtle quickstart link under the install command; bottom section shows the CTA in the correct language.
  • Clicking either lands on the quickstart page, which renders with Docusaurus' native right-side TOC for the six section headings.

🤖 Generated with Claude Code

montfort and others added 2 commits May 20, 2026 16:29
Two homepage surfaces lead to a new standalone /quickstart page:

- a subtle "…then follow our short quickstart guide →" line right under
  the install command in the Hero
- a "Ready to try it?" section at the bottom of the landing with a
  single prominent CTA button

The /quickstart page itself is one long MDX with six sections — install,
init, your first Charter, AILOG, status & validate, and the multi-model
audit cycle — designed for a developer who has decided to try the tool
and wants the shortest end-to-end path. Around 10–15 minutes of reading,
heavy on copy-paste-able commands, deliberately not docs-depth.

EN only for now; es/zh-CN fall back gracefully. Five new home-surface
strings are translated to es and zh-CN in this PR.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…uickstart hint

Two small Hero tweaks:

- add an "Install the CLI in one line" eyebrow above the curl block
  (translated to es and zh-CN) so the command has a header that names
  what it does
- bump the bottom margin under the quickstart hint from 0 to 1rem so
  the "Read the docs / Read the chronicle" buttons aren't hugging the
  hint line

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@montfort montfort merged commit 4602cd8 into main May 21, 2026
1 check passed
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