Skip to content

📖 start of reports dashboard updates#6976

Open
youngcw wants to merge 12 commits intomasterfrom
youngcw/update-report-page
Open

📖 start of reports dashboard updates#6976
youngcw wants to merge 12 commits intomasterfrom
youngcw/update-report-page

Conversation

@youngcw
Copy link
Member

@youngcw youngcw commented Feb 14, 2026

Getting the basics ready for better reports documentation.

@actual-github-bot actual-github-bot bot changed the title start of reports dashboard updates [WIP] start of reports dashboard updates Feb 14, 2026
@netlify
Copy link

netlify bot commented Feb 14, 2026

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit f4a868e
🔍 Latest deploy log https://app.netlify.com/projects/actualbudget/deploys/6990f832441c920008a6b167
😎 Deploy Preview https://deploy-preview-6976.demo.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions

This comment has been minimized.

@netlify
Copy link

netlify bot commented Feb 14, 2026

Deploy Preview for actualbudget-website ready!

Name Link
🔨 Latest commit cd5f896
🔍 Latest deploy log https://app.netlify.com/projects/actualbudget-website/deploys/6990e7db657d8a0008ec754f
😎 Deploy Preview https://deploy-preview-6976.www.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 14, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Sidebar label changed from "Reports" to "Reports Dashboard". The main reports page was rewritten toward a dashboard-centric structure: built-in reports converted into dashboard widgets, new images and headings added, navigation reordered, and an "Experimental Features" subsection introduced. (50 words)

Changes

Cohort / File(s) Summary
Sidebar & Reports Index
packages/docs/docs-sidebar.js, packages/docs/docs/reports/index.md
Renamed sidebar entry to "Reports Dashboard". Rewrote index.md to describe a configurable, multi-dashboard experience: new intro copy, updated imagery, converted static reports into dashboard widgets/reports (e.g., Cash Flow Report, Net Worth Graph, Spending Analysis Report, Text Widget, Summary Card, Calendar Card), reordered headings, and added an "Experimental Features" subsection (Crossover Point, Budget Analysis).
Custom Reports Image Alt Text
packages/docs/docs/reports/custom-reports.md
Adjusted image alt text from "Custom Report Dashboard example" to "Custom Report examples" only; no other content changes.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I hopped through pages, nudged a name anew,
Reports became dashboards with a brighter view,
Widgets prance, graphs wink, experiments peek,
I plant a carrot mark where headings sneak,
A tiny rabbit cheers — fresh docs, huzzah!

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The description is vague and generic, using non-specific language like 'basics' and 'better' without conveying meaningful details about the actual changeset modifications. Consider providing more specific details about what documentation updates are being made, such as the renaming from 'Reports' to 'Reports Dashboard' and restructuring of content.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main changes: updating reports documentation by renaming 'Reports' to 'Reports Dashboard' and preparing foundational content changes.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into master

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch youngcw/update-report-page

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Contributor

🤖 Auto-generated Release Notes

Hey @youngcw! I've automatically created a release notes file based on CodeRabbit's analysis:

Category: Enhancements
Summary: Start updates for the reports dashboard to enhance user experience and functionality.
File: upcoming-release-notes/6976.md

If you're happy with this release note, you can add it to your pull request. If not, you'll need to add your own before a maintainer can review your change.

@netlify
Copy link

netlify bot commented Feb 14, 2026

Deploy Preview for actualbudget-website ready!

Name Link
🔨 Latest commit c0da7db
🔍 Latest deploy log https://app.netlify.com/projects/actualbudget-website/deploys/6990e82a1683bb0008032d07
😎 Deploy Preview https://deploy-preview-6976.www.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@youngcw youngcw changed the title [WIP] start of reports dashboard updates start of reports dashboard updates Feb 14, 2026
@youngcw youngcw changed the title start of reports dashboard updates 📖 start of reports dashboard updates Feb 14, 2026
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 6

🤖 Fix all issues with AI agents
In `@packages/docs/docs-sidebar.js`:
- Line 188: The sidebar label currently reads 'Reports Dashboard' but the page
title in index.md is 'Reports Dashboards'; make them consistent by either
renaming the sidebar label string 'Reports Dashboard' to 'Reports Dashboards' or
updating the index.md title to 'Reports Dashboard'—ensure the label in
docs-sidebar.js and the title in index.md match exactly.

In `@packages/docs/docs/reports/index.md`:
- Line 8: Replace the incorrect contraction "it's" with the possessive "its" in
the sentence "If one dashboard is not enough, you can make as many dashboards as
you like, each with it's own set of reports and widgets." (look for that exact
sentence in packages/docs/docs/reports/index.md) so it reads "each with its own
set of reports and widgets."
- Line 15: Update the sentence "Currently, Actual comes with the following built
in widgets and reports:" to hyphenate the compound adjective by changing "built
in" to "built-in" (i.e., "Currently, Actual comes with the following built-in
widgets and reports:") so the phrase is grammatically correct; locate and edit
that exact string in the docs content for the file where it appears.
- Around line 36-41: In the "## Net Worth Graph" paragraph remove the duplicated
sentence "Net worth shows the balance of all accounts over time" so it only
appears once, and fix the grammar by changing "minus and debts you owe" to
"minus any debts you owe"; update the paragraph text under the heading to read
clearly (keep references to investments and the definition of net worth) so the
duplicate is gone and "and" is replaced with "any".
- Line 38: The Markdown image tag currently has no alt text
(![](/img/reports/net-worth.webp)); update this line to include a concise,
descriptive alt string that explains the image (for example "Net worth chart
showing assets and liabilities over time") so the image becomes accessible to
screen readers and static analysis passes; modify the alt text inside the square
brackets of the existing image reference in packages/docs/docs/reports/index.md.
- Line 23: The "[Custom Reports]" link currently points to the broken fragment
"#/docs/reports/custom-reports.md"; update that link target to a proper relative
page link (e.g., "custom-reports.md" or "./custom-reports.md" or the Docusaurus
route "/docs/reports/custom-reports" depending on site conventions) so the
"[Custom Reports]" anchor resolves correctly; locate the link text "[Custom
Reports]" in the markdown and replace the URL portion
"#/docs/reports/custom-reports.md" with the chosen valid relative path.

{
type: 'category',
label: 'Reports',
label: 'Reports Dashboard',
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Inconsistent naming: "Reports Dashboard" vs "Reports Dashboards".

The sidebar label here is "Reports Dashboard" (singular), but the page title in index.md line 1 is "Reports Dashboards" (plural). Pick one and use it consistently.

🤖 Prompt for AI Agents
In `@packages/docs/docs-sidebar.js` at line 188, The sidebar label currently reads
'Reports Dashboard' but the page title in index.md is 'Reports Dashboards'; make
them consistent by either renaming the sidebar label string 'Reports Dashboard'
to 'Reports Dashboards' or updating the index.md title to 'Reports
Dashboard'—ensure the label in docs-sidebar.js and the title in index.md match
exactly.

Comment on lines 36 to 41
## Net Worth Graph

![](/img/reports/net-worth.webp)

Net worth shows the balance of all accounts over time. Your net worth is all of your cash and assets minus and debts you owe. Net worth shows the balance of all accounts over time, including all of your investments. Your "net worth" is considered to be the amount you'd have if you sold all your assets and paid off as much debt as possible.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Duplicate sentence and grammar error in Net Worth description.

Line 40 has two issues:

  1. "minus and debts" should be "minus any debts."
  2. "Net worth shows the balance of all accounts over time" appears twice in the same paragraph.
-Net worth shows the balance of all accounts over time. Your net worth is all of your cash and assets minus and debts you owe. Net worth shows the balance of all accounts over time, including all of your investments. Your "net worth" is considered to be the amount you'd have if you sold all your assets and paid off as much debt as possible.
+Net worth shows the balance of all accounts over time, including all of your investments. Your net worth is all of your cash and assets minus any debts you owe. Your "net worth" is considered to be the amount you'd have if you sold all your assets and paid off as much debt as possible.
🧰 Tools
🪛 LanguageTool

[grammar] ~40-~40: Ensure spelling is correct
Context: ...th is all of your cash and assets minus and debts you owe. Net worth shows the bala...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.20.0)

[warning] 38-38: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents
In `@packages/docs/docs/reports/index.md` around lines 36 - 41, In the "## Net
Worth Graph" paragraph remove the duplicated sentence "Net worth shows the
balance of all accounts over time" so it only appears once, and fix the grammar
by changing "minus and debts you owe" to "minus any debts you owe"; update the
paragraph text under the heading to read clearly (keep references to investments
and the definition of net worth) so the duplicate is gone and "and" is replaced
with "any".

@netlify
Copy link

netlify bot commented Feb 14, 2026

Deploy Preview for actualbudget-website ready!

Name Link
🔨 Latest commit f4a868e
🔍 Latest deploy log https://app.netlify.com/projects/actualbudget-website/deploys/6990f8323f76850008986cb3
😎 Deploy Preview https://deploy-preview-6976.www.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@packages/docs/docs/reports/index.md`:
- Line 13: Replace the empty alt text in the image markdown
"![](/img/reports/reports-dashboard.webp)" with a concise, descriptive alt
string that conveys the content and purpose of the image (for example: "Reports
dashboard showing key metrics, charts, and filters"); update the line in
packages/docs/docs/reports/index.md so the image uses that descriptive alt text
to satisfy accessibility and markdownlint requirements.
- Line 32: The image markdown for /img/reports/cash-flow.webp currently has an
empty alt attribute; replace the empty brackets in the line
"![](/img/reports/cash-flow.webp)" with a short, descriptive alt text (e.g.
"Cash flow chart showing monthly inflows and outflows") so the image has
meaningful accessibility text and satisfies markdownlint.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@packages/docs/docs/reports/index.md`:
- Line 52: The heading text "Use markdown to generate a text box to use as
report headings and organizational labels." should capitalize the proper noun
"Markdown"; update the string containing "Use markdown ..." (search for that
exact phrase) to "Use Markdown to generate a text box to use as report headings
and organizational labels." so the language name is correctly capitalized.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@packages/docs/docs/reports/index.md`:
- Around line 30-34: The "Cash Flow Graph" heading and the image alt text "Cash
flow Report" are inconsistent; update the image alt text in the markdown (the
alt string in the ![...]) to match the heading—e.g., change "Cash flow Report"
to "Cash Flow Graph" so the alt text and the "Cash Flow Graph" heading are
identical.
🧹 Nitpick comments (1)
packages/docs/docs/reports/index.md (1)

9-9: Consider simplifying "All of the" to "All the" for conciseness.

This is a minor style suggestion to make the sentence more concise.

✏️ Proposed simplification
-All of the available reports can be tuned with filters and live or static date ranges.
+All the available reports can be tuned with filters and live or static date ranges.

Comment on lines 30 to 34
## Cash Flow Graph

![](/img/reports/cash-flow.webp)
![Cash flow Report](/img/reports/cash-flow.webp)

Cash flow shows your spending over time. It only looks at budgeted accounts and shows their balance over time, and includes separate income and expense visualizations. It's a quick way to see how your income and expenses affected your available money over time. Your budgeted accounts are considered to be "cash on hand," so this gives you a picture of how available money fluctuates.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Inconsistency: heading says "Graph" but image alt text says "Report".

The section heading is "Cash Flow Graph" but the image alt text says "Cash flow Report". These should match for consistency.

📝 Proposed fix for consistency
-![Cash flow Report](/img/reports/cash-flow.webp)
+![Cash Flow Graph](/img/reports/cash-flow.webp)
🤖 Prompt for AI Agents
In `@packages/docs/docs/reports/index.md` around lines 30 - 34, The "Cash Flow
Graph" heading and the image alt text "Cash flow Report" are inconsistent;
update the image alt text in the markdown (the alt string in the ![...]) to
match the heading—e.g., change "Cash flow Report" to "Cash Flow Graph" so the
alt text and the "Cash Flow Graph" heading are identical.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant