diff --git a/AGENTS.md b/AGENTS.md index cd3ed469f1..ae5c4970d1 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -7,7 +7,7 @@ This guide provides comprehensive information for AI agents (like Cursor) workin **Actual Budget** is a local-first personal finance tool written in TypeScript/JavaScript. It's 100% free and open-source with synchronization capabilities across devices. - **Repository**: https://github.com/actualbudget/actual -- **Community Docs**: https://github.com/actualbudget/docs or https://actualbudget.org/docs +- **Community Docs**: https://github.com/actualbudget/actual/tree/master/packages/docs or https://actualbudget.org/docs - **License**: MIT - **Primary Language**: TypeScript (with React) - **Build System**: Yarn 4 workspaces (monorepo) diff --git a/packages/docs/README.md b/packages/docs/README.md index a319211464..45d611cbb1 100644 --- a/packages/docs/README.md +++ b/packages/docs/README.md @@ -7,7 +7,7 @@ This repo is the Actual Budget community documentation website, built using [Doc ## Welcome Firstly, thank you for stopping by and giving up some of your time to either check out the documentation we have already produced or pick off -some of the [issues](https://github.com/actualbudget/docs/issues) and help create some new documentation for our future users. Check out the +some of the [issues](https://github.com/actualbudget/actual/issues?q=is%3Aissue%20state%3Aopen%20label%3Adocumentation) and help create some new documentation for our future users. Check out the [guidelines](https://actualbudget.org/docs/contributing/writing-docs) for more information on how the documentation is structured and tips for consistent formatting. ### Installation Methods @@ -21,7 +21,7 @@ Actual Budget can be installed on many different platforms. However, at this tim * PikaPods * Docker -If you would like to write documentation for another installation variant, please feel free to continue to do this and host it on your own personal blog, Medium, Tumblr, or any other short-form publication service. We will be more than happy to add a link to that from our documentation. Open a [PR](https://github.com/actualbudget/docs/pulls) and add it to the list in the [installation overview](https://actualbudget.org/docs/install/#additional-installation-options). +If you would like to write documentation for another installation variant, please feel free to continue to do this and host it on your own personal blog, Medium, Tumblr, or any other short-form publication service. We will be more than happy to add a link to that from our documentation. Open a [PR](https://github.com/actualbudget/actual/pulls) and add it to the list in the [installation overview](https://actualbudget.org/docs/install/#additional-installation-options). However, in doing so, you would become responsible for these instructions. If they become out of date or people want in-depth help with them, we will point them to you for assistance if the community is unable to help. If lots of people report issues with them, we may have to remove the link altogether. @@ -32,7 +32,7 @@ Please review the contributing documentation on our website: https://actualbudge ### Issues -If you know of a part of Actual that isn't documented and you would like to know more about that part of the software, open an [Issue](https://github.com/actualbudget/docs/issues) and one of the documentation team will get to it. Or have a go at writing it yourself; we could really use all the help we can get. +If you know of a part of Actual that isn't documented and you would like to know more about that part of the software, open an [Issue](https://github.com/actualbudget/actual/issues/new?template=documentation.yml) and one of the documentation team will get to it. Or have a go at writing it yourself; we could really use all the help we can get. ### Pull Requests diff --git a/packages/docs/docs/contributing/project-details/index.md b/packages/docs/docs/contributing/project-details/index.md index 65ef669258..56731f9c54 100644 --- a/packages/docs/docs/contributing/project-details/index.md +++ b/packages/docs/docs/contributing/project-details/index.md @@ -2,10 +2,7 @@ Actual is made up of lots of different _packages_. This article covers how they all fit together to form the project you know as Actual Budget. -All of the repositories can be found in the [Actual Budget](https://github.com/actualbudget) organization on GitHub, within that organization you will then find the following repositories - -- [Actual & Actual Server](https://github.com/actualbudget/actual) -- [docs](https://github.com/actualbudget/docs) +All of our repositories can be found in the [Actual Budget](https://github.com/actualbudget) organization on GitHub, within that organization you will then find the repository containing the code for [Actual, Actual Server and the Docs](https://github.com/actualbudget/actual). ## Actual diff --git a/packages/docs/docs/contributing/writing-docs.md b/packages/docs/docs/contributing/writing-docs.md index 951f06b3fb..a7fb63673a 100644 --- a/packages/docs/docs/contributing/writing-docs.md +++ b/packages/docs/docs/contributing/writing-docs.md @@ -21,7 +21,7 @@ We generate our website using the [Docusaurus](https://docusaurus.io/) system, a If you're interested in contributing, you'll need to know about the following two resources: -* [Actual documentation repository on GitHub](https://github.com/actualbudget/docs) +* [Actual documentation repository on GitHub](https://github.com/actualbudget/actual/tree/master/packages/docs) * [Actual Budget #documentation channel on Discord](https://discord.com/channels/937901803608096828/1027831463103696928) diff --git a/packages/docs/docs/index.md b/packages/docs/docs/index.md index 8720ba7344..f7bf658241 100644 --- a/packages/docs/docs/index.md +++ b/packages/docs/docs/index.md @@ -20,4 +20,4 @@ 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/docs?tab=readme-ov-file). +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). diff --git a/packages/docs/docusaurus.config.js b/packages/docs/docusaurus.config.js index 3dc3beb7ef..14d72bc01f 100644 --- a/packages/docs/docusaurus.config.js +++ b/packages/docs/docusaurus.config.js @@ -4,7 +4,7 @@ const { themes } = require('prism-react-renderer'); const defaultOptions = { - editUrl: 'https://github.com/actualbudget/docs/tree/master/', + editUrl: 'https://github.com/actualbudget/actual/tree/master/packages/docs', beforeDefaultRemarkPlugins: [require('./src/remark/mentions')], }; @@ -132,7 +132,7 @@ module.exports = { }, { label: 'Website Source', - href: 'https://github.com/actualbudget/docs', + href: 'https://github.com/actualbudget/actual/tree/master/packages/docs', }, { label: 'Privacy Policy', diff --git a/upcoming-release-notes/6113.md b/upcoming-release-notes/6113.md new file mode 100644 index 0000000000..54e12da813 --- /dev/null +++ b/upcoming-release-notes/6113.md @@ -0,0 +1,6 @@ +--- +category: Maintenance +authors: [matt-fidd] +--- + +Docs - remove references to the old docs repository