Skip to content
This repository was archived by the owner on Aug 7, 2026. It is now read-only.

Commit 9773abb

Browse files
docs: create version 1.1.5
1 parent 19f4dfa commit 9773abb

13 files changed

Lines changed: 705 additions & 0 deletions

File tree

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: FAQ
3+
description: Frequently asked questions about Eclosion for Monarch Money.
4+
sidebar_position: 99
5+
---
6+
7+
# Frequently Asked Questions
8+
9+
## Is Eclosion free?
10+
11+
Yes! Eclosion is completely free and open source. You can use it without any cost, and the source code is available on GitHub for review or contribution.
12+
13+
## How does Eclosion connect to Monarch Money?
14+
15+
Eclosion uses your Monarch Money credentials to authenticate directly with their API. Your credentials are stored securely on your device and are never sent to any third-party servers.
16+
17+
## Is the app signed and secure?
18+
19+
The macOS version is fully signed and notarized by Apple, so it installs seamlessly. Windows and Linux builds are currently unsigned, but you can verify the source code on GitHub and build the app yourself if preferred.
20+
21+
## Does Eclosion work on all operating systems?
22+
23+
Eclosion is available for macOS (Intel & Apple Silicon), Windows (x64), and Linux (x64). You can also use the web-based demo to try it out before downloading.
24+
25+
## Will my data be safe?
26+
27+
Absolutely. Eclosion only communicates with Monarch Money servers. There are no analytics, telemetry, or third-party services. Your financial data stays between you and Monarch.
28+
29+
## What happens if Monarch releases a similar feature?
30+
31+
We deliberately focus on features outside Monarch's near-term roadmap. If Monarch does release comparable functionality, we'll provide a migration option so you can port your data to their native implementation. Our goal is to enhance your Monarch experience, not compete with it.
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Getting Started
3+
description: Learn the basics of using Eclosion with your Monarch Money account.
4+
sidebar_position: 1
5+
slug: /
6+
---
7+
8+
# Getting Started with Eclosion
9+
10+
Welcome to Eclosion! This guide will walk you through the basics of using the app to manage your recurring expenses.
11+
12+
## What is Eclosion?
13+
14+
Eclosion extends Monarch Money with tools for tracking recurring expenses, saving for one-time purchases, adding notes to categories, and managing your budget more effectively. It connects to your Monarch account and adds features that help you:
15+
16+
- Track recurring bills and subscriptions
17+
- Save for one-time purchases with your wishlist
18+
- Add notes to any category that carry forward monthly
19+
- See your true monthly spending commitments
20+
- Create budget categories automatically
21+
22+
## First Steps
23+
24+
After logging in, you'll land on the Dashboard. Here's what to do next:
25+
26+
1. Head to the **Recurring** tab to set up expense tracking
27+
2. Follow the setup wizard to configure your categories
28+
3. Link your existing Monarch categories or create new ones
29+
4. Visit the **Wishlist** tab to create savings goals for one-time purchases
30+
5. Visit the **Notes** tab to add context to your budget categories
31+
32+
:::tip
33+
If you're new to Eclosion, interactive tours on the Recurring and Notes pages will guide you through each interface. Look for the help icon in the top right.
34+
:::
35+
36+
## Need Help?
37+
38+
- Use the help icon in the app for context-specific guidance
39+
- Browse the sidebar for troubleshooting and feature guides
40+
- Visit our [GitHub Discussions](https://github.com/312-dev/eclosion/discussions) for community support
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"label": "Monthly Notes",
3+
"position": 2,
4+
"collapsible": true,
5+
"collapsed": false,
6+
"link": {
7+
"type": "doc",
8+
"id": "notes/overview"
9+
}
10+
}
Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
title: Overview
3+
description: Learn how to add notes to your Monarch categories and track budgeting decisions over time.
4+
sidebar_position: 1
5+
---
6+
7+
import { FeatureCard, FeatureGrid } from '@site/src/components/FeatureCard';
8+
import { WorkflowSteps } from '@site/src/components/WorkflowSteps';
9+
import { StickyNote, Calendar, History, Calculator } from 'lucide-react';
10+
11+
# Monthly Notes
12+
13+
The Notes tab helps you remember why you set each budget. Add notes to any Monarch category or category group that carry forward each month.
14+
15+
<FeatureGrid>
16+
<FeatureCard
17+
icon={<StickyNote size={24} />}
18+
title="Category Notes"
19+
description="Attach notes to any category or group to track your reasoning"
20+
/>
21+
<FeatureCard
22+
icon={<Calendar size={24} />}
23+
title="Carry Forward"
24+
description="Notes automatically appear in future months until changed"
25+
/>
26+
<FeatureCard
27+
icon={<History size={24} />}
28+
title="Revision History"
29+
description="See how your notes evolved over time"
30+
/>
31+
<FeatureCard
32+
icon={<Calculator size={24} />}
33+
title="Inline Math"
34+
description="Type math expressions and press Tab to evaluate"
35+
/>
36+
</FeatureGrid>
37+
38+
## How It Works
39+
40+
Your notes are organized to match your Monarch category structure:
41+
42+
### Category Groups
43+
44+
Category groups from Monarch appear as expandable sections. Click a group to see its categories. You can add notes to both the group level and individual categories within it.
45+
46+
### General Month Notes
47+
48+
Use the sidebar (desktop) or top section (mobile) for notes that don't belong to a specific category. Great for:
49+
50+
- Monthly goals and priorities
51+
- Budget reminders
52+
- End-of-month summaries
53+
54+
## Adding Notes
55+
56+
<WorkflowSteps
57+
title="Creating Your First Note"
58+
steps={[
59+
{
60+
title: "Navigate to Notes",
61+
description: "Click the Notes tab in the sidebar to open the notes view."
62+
},
63+
{
64+
title: "Find a Category",
65+
description: "Expand a category group and locate the category you want to annotate."
66+
},
67+
{
68+
title: "Click Add Note",
69+
description: "Click the \"+ Add note\" button next to the category name."
70+
},
71+
{
72+
title: "Write Your Note",
73+
description: "Type your note using markdown formatting. Notes save automatically as you type."
74+
}
75+
]}
76+
/>
77+
78+
:::tip
79+
Notes support markdown formatting including **bold**, *italics*, bullet lists, and checkboxes. Use checkboxes to track action items for the month.
80+
:::
81+
82+
## Navigating Months
83+
84+
Use the month navigator at the top to move between months:
85+
86+
- **Arrow buttons**: Move forward or back one month at a time
87+
- **Click month/year**: Jump directly to any month with the calendar picker
88+
89+
When you navigate to a future month, your existing notes carry forward automatically. They'll appear as "inherited" until you modify them for that specific month.
90+
91+
## Inline Math
92+
93+
Type math expressions directly in your notes and press **Tab** to evaluate them. This is useful for quick calculations:
94+
95+
- `100 + 50` + Tab = `150`
96+
- `1200 / 12` + Tab = `100`
97+
- `250 * 1.08` + Tab = `270`
98+
99+
## Revision History
100+
101+
Every change to a note is saved in the revision history. Click the history icon on any note to:
102+
103+
- View all previous versions
104+
- See when each change was made
105+
- Restore a previous version if needed
106+
107+
## Exporting Notes
108+
109+
Export your notes to PDF for printing or sharing:
110+
111+
1. Click the **Export** button in the top right
112+
2. Select a date range (single month or range)
113+
3. Choose which category groups to include
114+
4. Download the formatted PDF
115+
116+
:::note
117+
Export is only available when you have at least one note in the selected range.
118+
:::
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"label": "Recurring Expenses",
3+
"position": 1,
4+
"collapsible": true,
5+
"collapsed": false,
6+
"link": {
7+
"type": "doc",
8+
"id": "recurring/overview"
9+
}
10+
}
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Category Linking
3+
description: Connect Eclosion items to existing Monarch categories.
4+
sidebar_position: 4
5+
---
6+
7+
# Category Linking
8+
9+
Category linking connects your Eclosion recurring items to existing categories in Monarch Money.
10+
11+
## When to Link
12+
13+
Link a category when:
14+
15+
- You already have a category in Monarch for an expense
16+
- You want to preserve your existing budget structure
17+
- You're migrating from manual tracking to Eclosion
18+
19+
## How to Link
20+
21+
1. Click the link icon next to any recurring item
22+
2. Search or browse available categories from your Monarch budget
23+
3. Select the category you want to link
24+
4. Choose whether to rename the category to match the recurring item
25+
5. Click **Link Category** to confirm
26+
27+
The item will now use that category for all transaction categorization.
28+
29+
## Name Sync Options
30+
31+
When linking, you can choose:
32+
33+
- **Rename to match recurring item**: Updates the Monarch category name to match the recurring expense (e.g., "Netflix")
34+
- **Keep existing name**: Preserves the original category name in Monarch
35+
36+
## Automatic Category Creation
37+
38+
If you don't link to an existing category, Eclosion will automatically create a new category in Monarch when the item is enabled for tracking. The category is created within your configured category group.
39+
40+
:::tip
41+
Already have a category set up? Use the link icon next to any item to quickly connect it and avoid creating duplicates.
42+
:::

0 commit comments

Comments
 (0)