Skip to content

Split Build instructions into combined tool guides - #56

Merged
avni merged 4 commits into
mainfrom
fix/issue-50-build-guides
Oct 26, 2026
Merged

avni merged 4 commits into
mainfrom
fix/issue-50-build-guides

Conversation

@MetzinAround

@MetzinAround MetzinAround commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Copilot Generated

Changes

  • Keep /build as the existing five tiles, with the normal header and footer.
  • Give each Copilot tool its own page: /build/app, /build/vscode, and /build/cli.
  • Show Windows and macOS instructions together. Remove the OS selector, embedded panels, and duplicate Mac guides.
  • Share the connection, prompt, testing, and continued-work steps through one layout and reusable components.
  • Start with a USB data connection only. Explain that the skill switches into Disk Mode when it copies an app; double-RESET is a troubleshooting fallback, not a prerequisite.
  • Keep automatic Disk Mode for later updates and manual eject instructions as a fallback.
  • Update the tiles and navigation. Keep the nine old tool/platform links working, including query strings, and document the new routes.

Refreshed for review

  • Updated against main 2da92a8 without rewriting published history. All five website branches also combine without conflicts.
  • The shared deployment test now checks that required Doom verification precedes the actual build command, rather than depending on a step's display name.
  • Combined validation: 267 tests pass, both 31-page production builds pass (/ and /badger.github.io/), and 104 built-output checks pass. Workflow lint and required Doom-asset checks pass.
  • All GitHub build checks pass at this PR's saved head. Nothing has been merged or deployed.
  • Preserved main's deployment-base handling in the Build tiles, navigation, return links, and old-guide redirects.
  • Six redirect tests pass, covering normal, encoded, and invalid fragments under both deployment bases.
  • Build and all three approved guides pass desktop/mobile checks in both themes. Approved instructions are unchanged.

Earlier focused verification

  • node --test tests/build-guide-navigation.test.mjs: 3 passing tests.
  • npm run build: passed; 26 pages, including all three new guides.
  • git diff --check: passed.
  • Chromium: all four routes loaded; all three guide pages refreshed directly.
  • Desktop at 1440px and mobile at 390px, in dark and light themes: all 16 combinations checked without clipping or horizontal overflow. The normal header/footer remain present.
  • Each guide has one page heading, five steps, one prompt, both OS instructions, and a working return link.
  • Tiles, desktop/mobile menus, the active Build group, keyboard focus, and prompt copying passed. Copy testing used a page-local mock and did not use the real clipboard.
  • Old links, encoded names, invalid fragments, query preservation, and hash changes passed.
  • Paragraph contrast exceeds 4.5:1 in both themes. Guide text at 200% also fits at 720px.

The repository star counter was replaced with complete test data during the isolated browser checks. Initial test-data and timing errors were corrected; no website changes were needed as a result.

Scope and limits

Related to #50. This covers the additional Build request only and does not close the issue. The App Store work remains separate in #55.

This checks the website, not a fresh installation of each desktop tool or a physical badge transfer. The automatic Disk Mode wording follows the user's correction and the installed badge skill's USB/physical-badge guidance. No hardware commands, dependency changes, or production deployment were made.

MetzinAround and others added 4 commits October 23, 2026 13:29
Refs #50

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 16600baa-96ad-4836-8e96-6b34a1c9fbd9
Preserve the approved guides and apply deployment-base handling to cards, return links, and legacy redirects. Keep the deployment step compatible with the existing asset checks.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 16600baa-96ad-4836-8e96-6b34a1c9fbd9
Cover root and prefixed deployments, including encoded and invalid old links. Avoid overlapping the catalog PR's additions to the shared site-path tests.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 16600baa-96ad-4836-8e96-6b34a1c9fbd9
Retain main's build-and-URL-verification step name. Assert that required Doom verification runs before the actual build command, avoiding unnecessary workflow conflicts between the website PRs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 16600baa-96ad-4836-8e96-6b34a1c9fbd9
@MetzinAround
MetzinAround marked this pull request as ready for review October 25, 2026 02:59
Copilot AI balanced review requested due to automatic review settings October 25, 2026 02:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The scoped guide consolidation preserves navigation compatibility and has no identified blocking defects.

No open issues 🎉

What changed in this PR

Reorganizes the website’s Build instructions into dedicated tool guides with combined Windows and macOS steps. This addresses the Build portion of #50 while leaving App Store work separate.

Changes:

  • Adds three guide routes and shared components, replacing embedded panels and duplicate Mac guides.
  • Updates navigation and preserves legacy fragment links, query strings, and deployment-base handling.
  • Clarifies automatic Disk Mode and manual fallbacks, documents routes, and adds redirect coverage.
File Description
tests/​doom-provisioning.test.mjs Checks verification precedes the actual build command.
tests/​build-guide-navigation.test.mjs Tests legacy fragments under both deployment bases.
src/​pages/​build/​vscode.astro Adds the VS Code guide route.
src/​pages/​build/​cli.astro Adds the Copilot CLI guide route.
src/​pages/​build/​app.astro Adds the Copilot App guide route.
src/​pages/​build.astro Keeps five tiles and redirects legacy guide links.
src/​lib/​build-guide-navigation.ts Maps legacy fragments to deployment-aware routes.
src/​layouts/​BuildGuideLayout.astro Provides shared guide framing and return navigation.
src/​content/​build-guides/​mac/​03-copilot-cli.mdx Removes the duplicate Mac CLI guide.
src/​content/​build-guides/​mac/​02-vscode.mdx Removes the duplicate Mac VS Code guide.
src/​content/​build-guides/​mac/​01-copilot-app.mdx Removes the duplicate Mac Copilot App guide.
src/​content/​build-guides/​03-copilot-cli.mdx Combines platform-specific CLI setup with shared steps.
src/​content/​build-guides/​02-vscode.mdx Combines platform-specific VS Code setup with shared steps.
src/​content/​build-guides/​01-copilot-app.mdx Combines Copilot App instructions with shared steps.
src/​components/​navigation.tsx Links directly to the new guide routes.
src/​components/​navigation-card.astro Removes obsolete embedded-guide metadata.
src/​components/​build-guide-test.astro Shares badge testing and manual eject instructions.
src/​components/​build-guide-panel.astro Removes the obsolete expandable guide panel.
src/​components/​build-guide-idea.astro Shares the example prompt and permission guidance.
src/​components/​build-guide-continue.astro Shares update, backup, and manual-copy guidance.
src/​components/​build-guide-connect.astro Shares USB connection and Disk Mode fallback instructions.
README.md Documents guide routes and shared content locations.

Review effort: Balanced

@avni
avni merged commit b76924f into main Oct 26, 2026
5 checks 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.

5 participants