Skip to content

docs: surface manual binary download on installation page#3123

Merged
bartlomieju merged 2 commits into
mainfrom
orch/issue-66
May 14, 2026
Merged

docs: surface manual binary download on installation page#3123
bartlomieju merged 2 commits into
mainfrom
orch/issue-66

Conversation

@fibibot
Copy link
Copy Markdown
Contributor

@fibibot fibibot commented May 14, 2026

Summary

On /runtime/getting_started/installation/, the manual binary download instructions sat as two unheaded sentences immediately after the cargo install block, so readers easily missed them (the reporter on the upstream issue almost left negative feedback because they didn't see the option).

This promotes that paragraph to its own ## Manual download H2, so it:

  • appears in the right-rail TOC for the installation page, and
  • sits at the same level as ## Docker / ## Testing your installation rather than being tucked under the Cargo build paragraph.

Wording is unchanged — only the heading is new.

Test plan

  • Build the site locally (deno task build) and confirm the new "Manual download" entry appears in the right-rail TOC of the installation page.
  • Visually confirm the section renders at H2 level between the Cargo build block and the Docker section.

cc @bartlomieju

Closes #2927
Closes bartlomieju/orchid-inbox#66

The manual download instructions sat as two unheaded sentences after the
Cargo build block, making them easy to miss. Promote them to an H2
section so the heading appears in the right-rail TOC and at the same
level as other install-method sections.

Closes #2927
Copy link
Copy Markdown
Contributor

@lunadogbot lunadogbot left a comment

Choose a reason for hiding this comment

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

Diff is the H2 heading at line 198 and a blank line — no wording change. Heading lands cleanly between ## Download and install (cargo block at the tail) and ## Docker, so the new section appears in the right-rail TOC at the same level as its siblings. ## Building from source at line 243 remains separately for the source-build path.

Lint CI is red on /styleguide/typography.mdx (Cannot resolve module "lume/jsx-runtime": relative URL with a cannot-be-a-base base) — same failure on every PR run today, unrelated to this diff. Deploy preview is green. Holding approval until CI is green.

@bartlomieju bartlomieju merged commit 00d09f4 into main May 14, 2026
2 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.

Feedback: /runtime/getting_started/installation/ - Positive

3 participants