docs: restructure usage-guides into grouped sections#117
Merged
yabirgb merged 7 commits intorotki:mainfrom Apr 10, 2026
Merged
Conversation
Reorganize the flat usage-guides directory into 8 grouped subdirectories mirroring the app navigation: portfolio, history, tax-accounting, data-management, integrations, settings, utilities, and advanced. - Move/rename 22 files into subdirectories - Split accounts-and-balances.md, api-keys.md, customization.md into 9 focused pages - Merge tiny utility pages (search, notes, background-tasks) into one - Add local Vite redirects plugin to generate redirect HTML at build time for all old URLs (with anchor-aware routing for split pages) - Update sidebar with grouped collapsible sections - Rename "Introduction" to "Getting Started" - Group Staking and Statistics under "Tracking" - Improve landing page with NavCards component and move disclaimer below - Add description frontmatter to all 49 content pages for llms.txt - Update ~76 internal cross-references across the docs tree - Fix dead links in premium/devices.md - Exclude redirect paths from vitepress-plugin-llms output
Refresh the default VitePress theme with modern styling: refined dark mode colors, Inter/JetBrains Mono fonts, polished code blocks, rounded corners on containers and tables, subtle hover effects on images, and cleaner link styling. Add NavCards component for the landing page navigation grid. Remove backdrop blur on nav to avoid rendering issues.
Add comprehensive dashboard documentation with screenshots covering total balance, net value graph, balance summary, assets table, liquidity pools, liabilities, and NFT balances. Fix documentation gaps found by cross-checking with frontend source: - Add Lido CSM staking section - Add Crypto.com, Coinbase Prime exchanges; remove dead Coinbase Pro - Add 6 missing external services (Blockscout, Helius, etc.) - Add Solana Event and Solana Swap Event types - Add missing settings across all settings pages - Add missing mappings section to asset management - Update airdrops to reference rotki/data repo dynamically - Add OKX region selector documentation
Add a step-by-step Quick Start Guide walking new users through install, account creation, adding blockchain/exchange accounts, optimizing with RPC nodes and indexer API keys, viewing the dashboard, reviewing history, and generating a PnL report. Reuses 6 existing screenshots.
Drop .html extensions from internal anchor links across faq, premium, contribution-guides, requirement-and-installation, and usage-guides settings/advanced pages for consistency with the restructured docs.
Wire up the vitepress-plugin-llms CopyOrDownloadAsMarkdownButtons component so each page shows a dropdown with Copy page, View as Markdown, Open in ChatGPT/Claude, and a Download button.
kelsos
force-pushed
the
feature/usage-guide-restructure
branch
from
3aca2ec to
1cabb2a
Compare
The rotki Premium activation section was off-topic in Exchange API Keys (which is about connecting centralized exchanges). Remove it and route the old /usage-guides/api-keys#rotki-premium anchor to /premium/api-keys via the redirect plugin.
kelsos
added a commit
to kelsos/rotki
that referenced
this pull request
Apr 10, 2026
The docs restructure (rotki/docs#117) moved event-types.md under the new tax-accounting/ subdirectory. Update the sync check workflow to point at the new location.
kelsos
added a commit
to kelsos/rotki
that referenced
this pull request
Apr 10, 2026
The rotki/docs usage-guides pages were moved into grouped subdirectories (rotki/docs#117). Update the in-app deep links so users land directly on the new pages instead of bouncing through redirect stubs. Also drop a stale .html extension from the language contribution link.
2 tasks
kelsos
added a commit
to rotki/rotki
that referenced
this pull request
Apr 10, 2026
The docs restructure (rotki/docs#117) moved event-types.md under the new tax-accounting/ subdirectory. Update the sync check workflow to point at the new location.
kelsos
added a commit
to rotki/rotki
that referenced
this pull request
Apr 10, 2026
The rotki/docs usage-guides pages were moved into grouped subdirectories (rotki/docs#117). Update the in-app deep links so users land directly on the new pages instead of bouncing through redirect stubs. Also drop a stale .html extension from the language contribution link.
5 tasks
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.
Summary
Large restructure of
usage-guides/into grouped subdirectories that mirror the app navigation, plus new content and theme polish.Phase 1 — Structural (no content changes)
portfolio/,history/,tax-accounting/,data-management/,integrations/,settings/,utilities/,advanced/accounts-and-balances.md→ 2,api-keys.md→ 2,customization.md→ 5)utilities/index.md.vitepress/plugins/redirects.tsgenerates redirect HTML files at build time (with<meta refresh>, canonical link, and JS anchor-aware routing for split pages) — replaces manual stub filesNavCardscomponent; disclaimer moved to bottomdescriptionfrontmatter to 49 content pages for richerllms.txtindex.html#link format across 7 filesPhase 2 — New content & gap fixes
portfolio/dashboard.md) with 2 webp screenshots, cross-checked against the Vue sourcequick-start.md) — 7-step walkthrough from install to first PnL report, reusing existing screenshotsTheme polish
Follow-up (separate PRs to rotki/rotki)
external-links.tsin the frontend to point to new doc URLsevent-types.mdto use the newtax-accounting/event-typespathTest plan
pnpm buildpasses with 0 dead linkspnpm lintcleanhistorical-events.html,api-keys.html, etc.)window.location.hashllms-full.txtoutputexternal-links.ts) redirect correctly