Commit Graph

27 Commits

Author SHA1 Message Date
Nik
d1055d00e6 Small fixes for API docs (#167) 2023-05-04 10:02:36 -04:00
Jed Fox
17b1f15eaf Add step to create a GitHub release when publishing a release (#154) 2023-04-17 15:54:12 -04:00
Matiss Janis Aboltins
67d314c8dd 🔖 (23.4.1) fix rule creation from transaction list (#153) 2023-04-16 18:09:22 +01:00
Matiss Janis Aboltins
374e2a839d 📝 update release instructions (#150) 2023-04-07 21:21:47 +01:00
Jed Fox
8fa23838c0 Use an IIAFE in the API example code 2023-04-06 19:45:27 -04:00
chris heazlewood
e7486b1299 Update Building-Windows.md (#143) 2023-03-30 19:43:18 -05:00
Eike Siewertsen
0e9154323a fix api example config typo. serverUrl -> serverURL (#138) 2023-03-22 08:32:37 -04:00
Jed Fox
13ecf64ddb Add docs for auto-generated release notes (#129)
People contributing will now be asked to create a file containing their
PR’s entry into the release notes when opening a PR.

This approach was inspired by Prettier’s release notes approach
(https://github.com/prettier/prettier/tree/main/changelog_unreleased).
Separate files are used to avoid merge conflicts (each file is
completely separate, whereas adding lines to a file would result in
merge conflicts each time a PR is merged).

Checks will nudge people to create these files for their PRs, and PRs
created from a `release/*` branch on the main repos will have an action
run that outputs the Markdown-formatted release notes into a comment on
their PR. That action will also delete the no-longer-needed release
notes files to prep for the next release. Make sure you merge `master`
into release branch before finishing the PR to ensure the release notes
are fully generated and cleaned up. (You may encounter check failures if
you haven’t merged `master`)
2023-03-16 14:40:44 -04:00
Matiss Janis Aboltins
4985cbff96 📝 update release instructions (#131)
Updating release instructions. The current instructions were slightly
outdated.
2023-03-13 21:40:10 -04:00
Jed Fox
89cf9a1e2f Add Prettier with config matching main repo (#111)
* Add Prettier with config matching main repo

* Run Prettier on all files
2023-03-04 17:56:58 +00:00
Matiss Janis Aboltins
bdfe900828 Versioning strategy (#105) 2023-02-25 08:48:11 +00:00
Jed Fox
7285753e2d Updates to the sidebar layout & content (#89)
* Run Prettier

* Add `@docusaurus/plugin-content-docs` as a direct dep

* Remove generated index pages, move Release Notes to the top level

* Move installing section inside “Getting Started”

* Rename “Using Actual” to “A Tour of Actual”

* Expand “Getting Started” by default

* Move “how it works” to the heading of the Budgeting section

* more changes

* polish styles of section headers

* Move old homepage to the start of the tour, add a new one

* A few updates to project-layout.md, remove mobile package

* Clarify that you can use a local server with preview builds

* A couple of tweaks to the Windows article

* Clarify the installation docs

* Fix some issues on the sync page

* Centralize the contact info into one page

* Fix homepage link

* Fix broken links on installation page
2023-02-03 05:05:52 +00:00
Jed Fox
992bcd730f Use a real UUID in the example code 2023-01-14 17:05:01 -05:00
Jed Fox
26fa00e3be Updates per latest changes 2023-01-14 17:01:42 -05:00
Jed Fox
13b09bfa9f Remove advice to use server files directly 2023-01-14 17:01:15 -05:00
Jed Fox
22f3c5954b Add “Connecting to a remote server” docs 2023-01-14 15:11:47 -05:00
Jed Fox
3ddfcc4dbf Update to match v5 API 2023-01-14 14:46:45 -05:00
Jed Fox
4cf165475a Add remaining methods to “Using the API” 2023-01-14 14:30:06 -05:00
Jed Fox
11114e9309 Fix build errors 2023-01-14 14:25:12 -05:00
Jed Fox
5c344ae62d Improve API docs 2023-01-14 11:44:38 -05:00
Jed Fox
a419fc0822 Update using-the-API.md 2023-01-14 11:27:58 -05:00
Rich Howell
a44b21859e Preview builds
Added preview builds overview
2023-01-10 14:40:26 +00:00
Rich In SQL
68c0aef4ac Update API.md
Broken link fix
2022-10-22 18:16:41 +01:00
Rich In SQL
4febb33833 Update API.md
Broken link fix
2022-10-22 18:14:27 +01:00
Rich In SQL
a0bc2cfeab ActualQL Examples
Examples on how to use ActualQL and a re-arrangement of the sidebar, this resolves #16
2022-10-21 14:10:33 +01:00
Rich In SQL
14d9afc768 Releasing Documentation
Migrating releasing
2022-10-18 18:19:25 +01:00
Rich In SQL
28d4ee94dd Init 2022-10-16 20:28:33 +01:00