[PR #7472] [CLOSED] [WIP] Docs revamped sidebar outline [DO NOT MERGE] #49011

Closed
opened 2026-04-26 10:52:40 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/7472
Author: @Juulz
Created: 4/11/2026
Status: Closed

Base: masterHead: docs-outline


📝 Commits (8)

  • 3a621f2 Update customThemeCatalog.json
  • 4b498c6 Update customThemeCatalog.json
  • 3ea1f15 [autofix.ci] apply automated fixes
  • de916bb Update customThemeCatalog.json
  • b51dd39 🎨 You Need A Theme Dark, based on 2026 nYNAB dark
  • 34cef14 YNA Theme Dark
  • 826ef3a [AI] Reorganize docs layout and update sidebar outline
  • ebc2403 [autofix.ci] apply automated fixes

📊 Changes

35 files changed (+195 additions, -175 deletions)

View changed files

📝 packages/desktop-client/src/data/customThemeCatalog.json (+6 -0)
📝 packages/docs/docs-sidebar.js (+163 -173)
packages/docs/docs/accounts/add-accounts.md (+3 -0)
📝 packages/docs/docs/accounts/bank-sync.md (+0 -0)
📝 packages/docs/docs/accounts/bank-sync/gocardless.md (+0 -0)
📝 packages/docs/docs/accounts/bank-sync/pluggyai.md (+0 -0)
📝 packages/docs/docs/accounts/bank-sync/simplefin.md (+0 -0)
📝 packages/docs/docs/accounts/credit-cards/carrying-debt.md (+0 -0)
📝 packages/docs/docs/accounts/credit-cards/index.md (+0 -0)
📝 packages/docs/docs/accounts/credit-cards/paying-in-full.md (+0 -0)
📝 packages/docs/docs/accounts/index.md (+1 -1)
📝 packages/docs/docs/accounts/joint-accounts.md (+0 -0)
📝 packages/docs/docs/budgeting/goal-templates.md (+0 -0)
📝 packages/docs/docs/budgeting/monthly-cleanup.md (+0 -0)
📝 packages/docs/docs/budgeting/restart.md (+0 -0)
packages/docs/docs/getting-started/add-accounts.md (+3 -0)
packages/docs/docs/getting-started/add-categories.md (+3 -0)
packages/docs/docs/getting-started/add-transactions.md (+3 -0)
packages/docs/docs/getting-started/reconcile-new.md (+3 -0)
packages/docs/docs/getting-started/start-new-month.md (+3 -0)

...and 15 more files

📄 Description

Description

This is a revamped outline of what I think the sidebar of Docs should look like.
I have moved most of the files to their respective sidebar folder locations, including experimental features. The docs are currently located kinda all over the place.

To make experimental feature docs easier in the future, IMO, experimental feature docs should go to their respective end-place in the sidebar and be put in their final folder when introduced. A ToC of experimental features gets added to the experimental index that lives in the settings folder (this is not done yet).

There are A LOT of broken links in this deploy, but the main outline is working. I do not want to update links and start the work on the Quick Start Guide unless the maintainers are on board.

The changes will come in small PRs as they get completed.

What say you?

Will fix #6190 (Quick Start Guide) and #6188 when complete. @StephenBrown2 has some great ideas on keeping screenshots UTD.

Testing

Viewed sidebar of docs

Checklist

  • Release notes added (see link above)
  • No obvious regressions in affected areas
  • Self-review has been performed - I understand what each change in the code does and why it is needed

Bundle Stats

Bundle Files count Total bundle size % Changed
desktop-client 28 12.9 MB 0%
loot-core 1 4.84 MB 0%
api 1 3.88 MB 0%
cli 1 7.89 MB 0%
View detailed bundle stats

desktop-client

Total

Files count Total bundle size % Changed
28 12.9 MB 0%
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
static/js/index.js 3.32 MB 0%
static/js/BackgroundImage.js 121.09 kB 0%
static/js/FormulaEditor.js 852.77 kB 0%
static/js/ReportRouter.js 1.17 MB 0%
static/js/TransactionList.js 82.49 kB 0%
static/js/Value.js 4.33 MB 0%
static/js/ca.js 191.98 kB 0%
static/js/da.js 104.66 kB 0%
static/js/de.js 174.38 kB 0%
static/js/en-GB.js 8.2 kB 0%
static/js/en.js 175.89 kB 0%
static/js/es.js 181.8 kB 0%
static/js/extends.js 485.17 kB 0%
static/js/fr.js 177.08 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.46 kB 0%
static/js/it.js 165.95 kB 0%
static/js/narrow.js 363.02 kB 0%
static/js/nb-NO.js 151.85 kB 0%
static/js/nl.js 108.93 kB 0%
static/js/pl.js 88.34 kB 0%
static/js/pt-BR.js 177.44 kB 0%
static/js/resize-observer.js 18.06 kB 0%
static/js/th.js 179.3 kB 0%
static/js/theme.js 30.79 kB 0%
static/js/uk.js 212.6 kB 0%
static/js/wide.js 295 B 0%
static/js/workbox-window.prod.es5.js 7.33 kB 0%
static/js/zh-Hans.js 110.05 kB 0%

loot-core

Total

Files count Total bundle size % Changed
1 4.84 MB 0%
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
kcab.worker.ddTTAQMt.js 4.84 MB 0%

api

Total

Files count Total bundle size % Changed
1 3.88 MB 0%
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
index.js 3.88 MB 0%

cli

Total

Files count Total bundle size % Changed
1 7.89 MB 0%
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger
No assets were bigger

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
cli.js 7.89 MB 0%

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/actualbudget/actual/pull/7472 **Author:** [@Juulz](https://github.com/Juulz) **Created:** 4/11/2026 **Status:** ❌ Closed **Base:** `master` ← **Head:** `docs-outline` --- ### 📝 Commits (8) - [`3a621f2`](https://github.com/actualbudget/actual/commit/3a621f2be952acf9a0d9e1fe54af20a7dac0d998) Update customThemeCatalog.json - [`4b498c6`](https://github.com/actualbudget/actual/commit/4b498c6558ff442adb3c1bbfe61af4a0d3bacd88) Update customThemeCatalog.json - [`3ea1f15`](https://github.com/actualbudget/actual/commit/3ea1f158f2aa30ef84770bb386fbf86448571c2f) [autofix.ci] apply automated fixes - [`de916bb`](https://github.com/actualbudget/actual/commit/de916bbdb57e06cc0ba3e7c094e1062847e5222b) Update customThemeCatalog.json - [`b51dd39`](https://github.com/actualbudget/actual/commit/b51dd397f5a6d7a6ff765892f96464dca74c73ab) 🎨 You Need A Theme Dark, based on 2026 nYNAB dark - [`34cef14`](https://github.com/actualbudget/actual/commit/34cef142f750a9e65d7b155f77ceff6c297ba015) YNA Theme Dark - [`826ef3a`](https://github.com/actualbudget/actual/commit/826ef3a7bdf4a25c0275bbeeb204069ec4933966) [AI] Reorganize docs layout and update sidebar outline - [`ebc2403`](https://github.com/actualbudget/actual/commit/ebc24031fe6e06042c51f1acfdfa72f801a881f2) [autofix.ci] apply automated fixes ### 📊 Changes **35 files changed** (+195 additions, -175 deletions) <details> <summary>View changed files</summary> 📝 `packages/desktop-client/src/data/customThemeCatalog.json` (+6 -0) 📝 `packages/docs/docs-sidebar.js` (+163 -173) ➕ `packages/docs/docs/accounts/add-accounts.md` (+3 -0) 📝 `packages/docs/docs/accounts/bank-sync.md` (+0 -0) 📝 `packages/docs/docs/accounts/bank-sync/gocardless.md` (+0 -0) 📝 `packages/docs/docs/accounts/bank-sync/pluggyai.md` (+0 -0) 📝 `packages/docs/docs/accounts/bank-sync/simplefin.md` (+0 -0) 📝 `packages/docs/docs/accounts/credit-cards/carrying-debt.md` (+0 -0) 📝 `packages/docs/docs/accounts/credit-cards/index.md` (+0 -0) 📝 `packages/docs/docs/accounts/credit-cards/paying-in-full.md` (+0 -0) 📝 `packages/docs/docs/accounts/index.md` (+1 -1) 📝 `packages/docs/docs/accounts/joint-accounts.md` (+0 -0) 📝 `packages/docs/docs/budgeting/goal-templates.md` (+0 -0) 📝 `packages/docs/docs/budgeting/monthly-cleanup.md` (+0 -0) 📝 `packages/docs/docs/budgeting/restart.md` (+0 -0) ➕ `packages/docs/docs/getting-started/add-accounts.md` (+3 -0) ➕ `packages/docs/docs/getting-started/add-categories.md` (+3 -0) ➕ `packages/docs/docs/getting-started/add-transactions.md` (+3 -0) ➕ `packages/docs/docs/getting-started/reconcile-new.md` (+3 -0) ➕ `packages/docs/docs/getting-started/start-new-month.md` (+3 -0) _...and 15 more files_ </details> ### 📄 Description ## Description This is a revamped outline of what I think the sidebar of Docs should look like. I have moved most of the files to their respective sidebar folder locations, including experimental features. The docs are currently located kinda all over the place. To make experimental feature docs easier in the future, IMO, experimental feature docs should go to their respective end-place in the sidebar and be put in their final folder when introduced. A ToC of experimental features gets added to the experimental index that lives in the settings folder (this is not done yet). There are A LOT of broken links in this deploy, but the main outline is working. I do not want to update links and start the work on the _Quick Start Guide_ unless the maintainers are on board. The changes will come in small PRs as they get completed. What say you? ## Related issue(s) Will fix #6190 (Quick Start Guide) and #6188 when complete. @StephenBrown2 has some great ideas on keeping screenshots UTD. ## Testing Viewed sidebar of docs ## Checklist - [ ] Release notes added (see link above) - [ ] No obvious regressions in affected areas - [ ] Self-review has been performed - I understand what each change in the code does and why it is needed <!--- actual-bot-sections ---> <!--- bundlestats-action-comment key:combined start ---> ### Bundle Stats Bundle | Files count | Total bundle size | % Changed ------ | ----------- | ----------------- | --------- desktop-client | 28 | 12.9 MB | 0% loot-core | 1 | 4.84 MB | 0% api | 1 | 3.88 MB | 0% cli | 1 | 7.89 MB | 0% <details> <summary>View detailed bundle stats</summary> #### desktop-client **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 28 | 12.9 MB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- static/js/index.js | 3.32 MB | 0% static/js/BackgroundImage.js | 121.09 kB | 0% static/js/FormulaEditor.js | 852.77 kB | 0% static/js/ReportRouter.js | 1.17 MB | 0% static/js/TransactionList.js | 82.49 kB | 0% static/js/Value.js | 4.33 MB | 0% static/js/ca.js | 191.98 kB | 0% static/js/da.js | 104.66 kB | 0% static/js/de.js | 174.38 kB | 0% static/js/en-GB.js | 8.2 kB | 0% static/js/en.js | 175.89 kB | 0% static/js/es.js | 181.8 kB | 0% static/js/extends.js | 485.17 kB | 0% static/js/fr.js | 177.08 kB | 0% static/js/indexeddb-main-thread-worker-e59fee74.js | 13.46 kB | 0% static/js/it.js | 165.95 kB | 0% static/js/narrow.js | 363.02 kB | 0% static/js/nb-NO.js | 151.85 kB | 0% static/js/nl.js | 108.93 kB | 0% static/js/pl.js | 88.34 kB | 0% static/js/pt-BR.js | 177.44 kB | 0% static/js/resize-observer.js | 18.06 kB | 0% static/js/th.js | 179.3 kB | 0% static/js/theme.js | 30.79 kB | 0% static/js/uk.js | 212.6 kB | 0% static/js/wide.js | 295 B | 0% static/js/workbox-window.prod.es5.js | 7.33 kB | 0% static/js/zh-Hans.js | 110.05 kB | 0% </div> </details> --- #### loot-core **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 4.84 MB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- kcab.worker.ddTTAQMt.js | 4.84 MB | 0% </div> </details> --- #### api **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 3.88 MB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- index.js | 3.88 MB | 0% </div> </details> --- #### cli **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 7.89 MB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** No assets were bigger **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- cli.js | 7.89 MB | 0% </div> </details> </details> <!--- bundlestats-action-comment key:combined end ---> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-26 10:52:40 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#49011