Skip to content

A local-first personal finance app

[Docs] Starting at the top, Introduction & Vision (#8083)

Juulz73063ee779a8
diff --git a/packages/docs/docs/index.md b/packages/docs/docs/index.md
index cccba096ec..c43f535341 100644
--- a/packages/docs/docs/index.md
+++ b/packages/docs/docs/index.md
@@ -4,20 +4,26 @@ sidebar_position: 1
title: 'Introduction'
---
-Welcome to Actual's documentation! This page provides you a quick introduction to Actual Budget and will help you navigate to the documentation to learn more about Actual.
+Welcome to Actual's documentation!
+
+## How to Get Around
+
+The left sidebar menu lists the main pages of the documentation. On mobile, it's the collapsed navigation menu icon at the top left. Click on a chevron to view more nested pages on a subject.
+
+The right sidebar of each page lists the outline of the page for quick navigation to a specific subject. On mobile, it's at the top under "On this page".
+
+If you aren't sure where to look for information, an entry in the search bar will show the most useful result at the top, and all results it finds will be available.
## Where to Begin?
-If you're new to Actual, but do not know where to start, please consult the [roadmap for new users](/docs/getting-started/roadmap-for-new-users.md).
+If you're new to Actual, consult the [roadmap for new users](/docs/getting-started/roadmap-for-new-users).
-You can also try to [install Actual](./install/index.md) on a computer to start.
-After installation, check out the [Tour of Actual](./tour/index.md) for a
-high-level overview of how Actual works. The next step is to read our
-[Starting Fresh](/docs/getting-started/starting-fresh) guide.
-Then we suggest dive into the more detailed documentation, check out the "Using Actual" section in the left menu.
+If you're new to budgeting, read about [envelope budgeting](/docs/getting-started/envelope-budgeting).
For help and support, [reach out to the maintainers and community](/contact).
## Want to Contribute?
-If you'd like to contribute to the Actual Budget's documentation, click "Edit this page" to contribute. We recommend you to go through the prerequisites. You can contribute to the documentation by clicking the "Edit this page" link at the bottom of any page. We also recommend you to check out documentation standard, local setup, and guidelines on using images and screenshots from [here](https://github.com/actualbudget/actual/tree/master/packages/docs#actual-budget-community-documentation).
+The Actual application is actively maintained and updated by a dedicated group of contributors and maintainers who do their best to keep these documents synchronized with the changes. If you notice anything incorrect you can [open an issue](https://github.com/actualbudget/actual/issues/new/choose) in github or note it in the [`#Documentation` channel](https://discord.com/channels/937901803608096828/1027831463103696928) in Discord.
+
+If you'd like to contribute to Actual Budget's documentation, start by reading the documentation standards, local setup, and guidelines on using images and screenshots located in the [contributing guide](/docs/contributing/writing-docs) and in the documentation's [github README file](https://github.com/actualbudget/actual/tree/master/packages/docs#actual-budget-community-documentation). We use Docusaurus to build our website. You can click on _Edit this page_ at the bottom left of every page to open that page's Markdown document.
diff --git a/packages/docs/docs/vision.md b/packages/docs/docs/vision.md
index 03275a6de1..5d1b8ea802 100644
--- a/packages/docs/docs/vision.md
+++ b/packages/docs/docs/vision.md
@@ -8,9 +8,23 @@ title: Actual Budget Vision
- take charge of their finances
- find financial peace of mind
-- actively engage in dreaming big and achieving your goals
+- actively engage in dreaming big and achieving their goals
-**Design principles**: Actual is designed using the following principles:
+## Primary Objectives
+
+- The user has full visibility into their budget
+ - The user has ownership and control of their data now, and in the future
+ - The user can view the current status and trends in their budget
+ - The user can keep track of their priorities and goals, whether they are long-term or short-term.
+
+- The user will enjoy a clean and fast experience
+ - The application is fully usable across all devices, offline and online
+ - The application supports multiple budgets, each one reachable by multiple devices
+ - The application is accessible
+
+## Design principles
+
+Actual is designed using the following principles:
- **Local-first**
- **Open**
@@ -23,7 +37,7 @@ title: Actual Budget Vision
### Local-first
-Actual is local first, meaning that the database that powers Actual Budget, and ultimately your budget, lives on your device. We don't store it on a server. Now you're wondering, what 'actual server' is for? Well, that allows you to sync changes to your budget on different devices. To do this, only the changes to the budget are sent to the server. The server stores the messages, and the client pulls down the change(s).
+Actual is local first; the database that powers Actual Budget, and ultimately your budget, lives on your device. It is not stored on a server. "Actual server" allows you to sync changes to your budget on different devices. To do this, only the changes to the budget are sent to the server. The server stores the messages, and the local client pulls down the change(s).
### Open
@@ -31,11 +45,11 @@ Actual is Open Source utilizing the MIT license. The code is open for anyone to
### User Interface
-The sleek and clutter-free user interface is simple to use for beginners and comes packed with a robust 'undo' system and progressive discoverability for advanced users. The responsive interface adapts to the screen size you are using to give you the best experience for that device. A desktop computer will have the full desktop experience designed to be used with a keyboard and mouse, while a tablet and phone will have an experience ideal for using touch screens. A native mobile app, often found in app stores and marketplaces, is not planned.
+The sleek and clutter-free user interface is built for beginners and advanced users alike. It comes packed with a robust 'undo' system and progressive discoverability. The responsive interface adapts to the screen size you are using to give you the best experience for that device. A desktop computer will have the full desktop experience designed to be used with a keyboard and mouse, while a tablet and phone will have an experience ideal for using touch screens. A native mobile app, often found in app stores and marketplaces, is not planned.
### Stable, Reliable, Secure.
-The contributors to Actual Budget don't just write the program; they USE the program.  We all have a vested interest in maintaining reliability, security, and stability. If issues are found, bug reports are welcomed so that issues can be remedied immediately.
+The contributors to Actual Budget don't just write the program; they USE the program.  We all have a vested interest in maintaining reliability, security, and stability. If issues are found, bug reports are welcomed so that issues can be remedied quickly.
### Privacy Focused
@@ -43,20 +57,10 @@ Actual has no trackers, and unless explicitly enabled, no third-party access is
### Community-driven
-Actual Budget, being community-driven means that development is driven by the community and the maintainers.
-
-### Primary Objectives
-
-- Full visibility into one's budget
- - The user owns and controls their data now, and in the future
- - View the current status and trends in a budget
- - Keep track of your priorities and goals, whether they are long term or short term.
-
-- Clean and fast user experience
- - Fully usable across all devices, offline and online
- - Multiple budgets, each one reachable by multiple devices
- - Accessible application
+Development is driven by the community and the maintainers.
### Third-party use
-Actual is [MIT licensed](https://github.com/actualbudget/actual/blob/master/LICENSE.txt) which allows for the use of the software without restriction. The Actual Budget project and community appreciate any submissions from third-party contributors to enhance and improve our amazing project. This appreciation extends to any single volunteer or company-sponsored participants alike. Let's continue to make Actual Budget the best personal finance tool together!
+Actual is [MIT licensed](https://github.com/actualbudget/actual/blob/master/LICENSE.txt) which allows for the use of the software without restriction. The Actual Budget project and community appreciate any submissions from third-party contributors to enhance and improve this amazing project. This gratitude extends to single volunteers and company-sponsored participants alike.
+
+Let's continue to make Actual Budget the best personal finance tool together!