docs: restructure installation section + fix broken anchors#118
Merged
yabirgb merged 3 commits intorotki:mainfrom Apr 10, 2026
Merged
Conversation
Several links pointed at anchors that don't exist on the target pages after the usage-guides restructure: - history/pnl.md: #adding-manual-trades → #add-edit-events - history/pnl.md: settings/general#manage-historical-price-oracle-cache → settings/blockchain#oracle-cache - Multiple settings/accounting#accounting-settings (no such anchor on the page) dropped to the plain page link - tax-accounting/guide.md: fix double-dash #add--edit-events slug
Split the old packaged-binaries.md page into three focused pages so the simple download path isn't buried under Docker self-hosting and binary verification content: - download.md — Linux/macOS/Windows install (quick start for users) - docker.md — Docker image, Compose, Traefik+auth, Watchtower, migration from desktop (~350 lines extracted) - verify.md — SHA512 checksums and GitHub artifact attestations Rewrite the install index.md as a 4-card decision page (Download / Docker / Verify / Build from source) plus a minimum system requirements table. Collapse the three near-identical "Backend setup for Linux/macOS/ Windows" sections in build-from-source.md into a single section with OS-specific tabs. Drop the stale VS140COMNTOOLS / anyapi-ms-win-crt troubleshooting for dated Windows issues. Rename the sidebar group "System Requirements & Installation" → "Installation" and add entries for all four pages. Add an anchor-aware redirect for the old /packaged-binaries path so external links into Docker/Verify sections still resolve correctly. Update two internal docs cross-references that linked to the old path.
False positive — 'Big Sur' is the macOS 11 codename, not a typo for 'Sure'. Used in requirement-and-installation/index.md in the minimum system requirements table.
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
2 participants
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.
Follow-up to the usage-guides restructure (#117) tackling two items from the post-merge review.
Installation section restructure
The old
requirement-and-installation/layout buried the simple install path under Docker self-hosting and binary verification content. A new user landing onpackaged-binaries.mdhad to scroll past SHA512 checksums, GitHub attestations, and ~350 lines of Docker Compose + Traefik setup before finding "download the AppImage and run it".This PR splits that single page into focused pages and makes the landing page actually useful:
download.md— Linux/macOS/Windows quick install (the simple path)docker.md— Docker image, Compose templates, Traefik+basic-auth, Watchtower, migrating from desktop (~350 lines extracted)verify.md— SHA512 checksums, GitHub Artifact Attestations, publisher signature checksbuild-from-source.md— collapsed three near-identical "Backend setup for Linux/macOS/Windows" sections into a single section with OS-specific tabs; dropped dated Windows 7-era VS140COMNTOOLS / anyapi-ms-win-crt troubleshootingindex.md— rewritten as a 4-card decision page (Download / Docker / Verify / Build from Source) plus a minimum system requirements tableThe sidebar group
"System Requirements & Installation"is renamed to"Installation"and now lists all five pages.An anchor-aware redirect for the old
/packaged-binariespath preserves links into the Docker/Verify sections so external references (blog posts, GitHub issues) keep working.Broken anchor fixes
Cross-check against the restructured pages surfaced a few dead anchors:
history/pnl.md—#adding-manual-trades→#add-edit-eventshistory/pnl.md—settings/general#manage-historical-price-oracle-cache→settings/blockchain#oracle-cachehistory/pnl.md,tax-accounting/guide.md,tax-accounting/accounting-rules.md— multiplesettings/accounting#accounting-settingsreferences (the anchor doesn't exist — the page-level H1 isn't an anchor) dropped to plain page linkstax-accounting/guide.md— fixed double-dash#add--edit-eventsslug (VitePress emits single-dash)Test plan