docs: Update README to accurately reflect current features and architecture #161

Merged

Copilot merged 2 commits from copilot/update-readme-to-reflect-current-features into main

2026-03-19 01:28:02 +00:00

Conversation 2 Commits 2 Files changed 1 +53 -22

Copilot commented

2026-03-18 12:46:21 +00:00

(Migrated from github.com)

Copy link

README described features that don't exist and omitted several that do. This PR rewrites the Features and Tech Stack sections to match the actual codebase.

Description

README contained multiple inaccuracies introduced by documenting aspirational or removed features rather than what is implemented.

Removed false claims:

Calendar described as a general event calendar with recurring events — it's a parental leave day-state tracker (work / parent 1 / parent 2 / double day)
Drag-and-drop attributed to Calendar — belongs to the Tasks board
"Parental Leave Calculator with Försäkringskassan integration" — does not exist
"Multi-user household support" and "shared views" — app is single-user; both parents are tracked within one account

Added missing features:

Tasks & Chores board (drag-and-drop, schedule types, completion, categories)
Dashboard lazy-loaded overview cards
Finance Templates with interval rules
Mortgages (lifecycle, principal/interest breakdown, rate history)
Credit Cards and Purchases tracking
Calendar Batch Edit
Full User Settings breakdown

Tech stack corrections:

Vuetify is the primary UI framework; Tailwind is a utility dependency — clarified
Chart.js usage scoped to balance month view and mortgage burn-down chart
Version corrected from 1.0.0 → 0.1.0 (aligns with package.json)
Last Updated set to March 2026

Type of Change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update
Refactoring (code change that neither fixes a bug nor adds a feature)
Performance improvement
Test coverage improvement

Testing

I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
I have tested this manually (if applicable)

Code Quality

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
My changes generate no new warnings or errors

CI/CD Checks

All automated tests pass
Code formatting (Pint) passes
JavaScript/TypeScript linting passes
Build process completes successfully

Additional Notes

No code changes — documentation only. CI checks not applicable.

Original prompt

This section details on the original issue you should resolve

<issue_title>README is outdated</issue_title>
<issue_description>The repo README is outdated and referencing features, solutions, and archtechture that are not in use or never was. The project should be gone through to make sure that the README actually reflects the features and functionality that is in place</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes niddelicious/parenting-tool#160

💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

README described features that don't exist and omitted several that do. This PR rewrites the Features and Tech Stack sections to match the actual codebase. ## Description README contained multiple inaccuracies introduced by documenting aspirational or removed features rather than what is implemented. **Removed false claims:** - Calendar described as a general event calendar with recurring events — it's a parental leave day-state tracker (work / parent 1 / parent 2 / double day) - Drag-and-drop attributed to Calendar — belongs to the Tasks board - "Parental Leave Calculator with Försäkringskassan integration" — does not exist - "Multi-user household support" and "shared views" — app is single-user; both parents are tracked within one account **Added missing features:** - Tasks & Chores board (drag-and-drop, schedule types, completion, categories) - Dashboard lazy-loaded overview cards - Finance Templates with interval rules - Mortgages (lifecycle, principal/interest breakdown, rate history) - Credit Cards and Purchases tracking - Calendar Batch Edit - Full User Settings breakdown **Tech stack corrections:** - Vuetify is the primary UI framework; Tailwind is a utility dependency — clarified - Chart.js usage scoped to balance month view and mortgage burn-down chart - Version corrected from `1.0.0` → `0.1.0` (aligns with `package.json`) - Last Updated set to March 2026 ## Type of Change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] Documentation update - [ ] Refactoring (code change that neither fixes a bug nor adds a feature) - [ ] Performance improvement - [ ] Test coverage improvement ## Testing - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [x] I have tested this manually (if applicable) ## Code Quality - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [x] My changes generate no new warnings or errors ## CI/CD Checks - [ ] All automated tests pass - [ ] Code formatting (Pint) passes - [ ] JavaScript/TypeScript linting passes - [ ] Build process completes successfully ## Additional Notes No code changes — documentation only. CI checks not applicable.  <details> <summary>Original prompt</summary> > > ---- > > *This section details on the original issue you should resolve* > > <issue_title>README is outdated</issue_title> > <issue_description>The repo README is outdated and referencing features, solutions, and archtechture that are not in use or never was. The project should be gone through to make sure that the README actually reflects the features and functionality that is in place</issue_description> > > ## Comments on the Issue (you are @copilot in this section) > > <comments> > </comments> > </details>  - Fixes niddelicious/parenting-tool#160  --- 💬 Send tasks to Copilot coding agent from [Slack](https://gh.io/cca-slack-docs) and [Teams](https://gh.io/cca-teams-docs) to turn conversations into code. Copilot posts an update in your thread when it's finished.

niddelicious (Migrated from github.com) approved these changes

2026-03-19 01:27:31 +00:00

coderabbitai[bot] commented

2026-03-19 01:27:42 +00:00

(Migrated from github.com)

Copy link

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Free

Run ID: f5d43984-bf7f-4bdd-baa1-e37ccebe91a8

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

📝 Coding Plan

Generate coding plan for human review comments

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

Tip

You can enable review details to help with troubleshooting, context usage and more.

Enable the reviews.review_details setting to include review details such as the model used, the time taken for each step and more in the review comments.

> [!IMPORTANT] > ## Review skipped > > Bot user detected. > > To trigger a single review, invoke the `@coderabbitai review` command. > > <details> > <summary>⚙️ Run configuration</summary> > > **Configuration used**: defaults > > **Review profile**: CHILL > > **Plan**: Free > > **Run ID**: `f5d43984-bf7f-4bdd-baa1-e37ccebe91a8` > > </details> > > You can disable this status message by setting the `reviews.review_status` to `false` in the CodeRabbit configuration file. > > Use the checkbox below for a quick retry: > - [ ]  🔍 Trigger review   <details> <summary>📝 Coding Plan</summary> - [ ]  Generate coding plan for human review comments </details>   --- <sub>Comment `@coderabbitai help` to get the list of available commands and usage tips.</sub>   > [!TIP] > <details> > <summary>You can enable review details to help with troubleshooting, context usage and more.</summary> > > Enable the `reviews.review_details` setting to include review details such as the model used, the time taken for each step and more in the review comments. > > </details>

Reviewers

No reviewers

niddelicious

Labels

Clear labels

bug

Something isn't working

documentation

Improvements or additions to documentation

duplicate

This issue or pull request already exists

enhancement

New feature or request

good first issue

Good for newcomers

help wanted

Extra attention is needed

invalid

This doesn't seem right

question

Further information is requested

wontfix

This will not be worked on

No labels

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

nidde/parenting-tool!161

Reference in a new issue

Repository

nidde/parenting-tool

Title

Body

No description provided.

Delete branch "copilot/update-readme-to-reflect-current-features"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?

Rows
Columns