docs: add downloads section + restructure installation/uninstall - #59
Merged
Conversation
Add a consolidated "Binary Downloads" subsection to the installation docs with direct links to every platform's release asset (using the stable releases/latest/download URLs), plus a dedicated macOS subsection mirroring the Windows one. Covers the new signed + notarized Apple Silicon build.
Reorganize the installation docs for findability: - Add a "Which Method?" decision table mapping use case -> method. - Reorder methods: Docker -> Kubernetes (Helm) -> Pre-built Binaries -> Install Script -> Package Managers -> Build from Source. - Consolidate the scattered binary docs (Binary Downloads, Manual Installation, Windows, macOS) into one "Pre-built Binaries" section with a single download table and per-OS run instructions. - Rewrite Uninstall to mirror every install method (Docker, binary, script, package managers, Cargo, Helm) with a quick-reference table. - Fix broken multi-line curl commands (missing line continuation). Add two reusable elements for structure: MinorHeader (h4, used for the per-OS sub-sections) and TipBlock (info callout).
secana
changed the title
Fold the per-method commands into the reference table and drop the Docker/Script/Helm detail blocks. Allow the long installer command to wrap within its cell.
- Fix references to a nonexistent 'run' CLI command (the subcommands are 'start' and 'config'); use 'start' in the Config File and CLI Arguments sections. - Standardize on '.cargo/config.toml' (modern name) and fix the '~./.cargo/config' typo. - Note that S3-stored crates must be backed up separately from the data folder. - Modernize example Cargo.toml snippets (edition 2021, drop stray space). - Convert the raw <h5> config/CLI group headers to anchored MinorHeaders and add a 'Jump to' quick-nav row for the Config Values groups.
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.
What
Reworks the Installation and Uninstall documentation (
/documentation) for structure and findability, and adds macOS to the pre-built binary downloads.Installation
Uninstall
Fixes
curlcommands (missing\line continuation) in the Linux and macOS download snippets — they would have failed if copy-pasted.Reusable elements added
MinorHeader.vue— an h4 header used for the per-OS sub-sections under Pre-built Binaries (and the Uninstall detail blocks), giving a clean third level of hierarchy.TipBlock.vue— an info callout (blue counterpart to the existingWarnBlock), used for the "Docker is easiest" recommendation.Anchor changes
Renamed anchors:
#binary-downloads→#pre-built-binaries,#script→#install-script,#cargo-install→#build-from-source,#manual-installation→#linux.#helm-chart,#docker-container,#package-managers,#windows,#macoskept. Verified no remaining internal references point at the old anchors.Testing
npm run type-check✅ ·npm run lint✅ ·npm run build✅Dependency (unchanged from before)
The macOS asset link goes live once kellnr PR #1302 merges and the next release is cut; every other link is already valid.