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`)
I'm not a user of this feature, but I thought I could get the ball
rolling on adding some documentation. I'm not 100% sure this is how this
budget type is used, so there are likely wrong assumptions. I'm hopeful
someone will either correct me or take the reigns. There have been
several users looking for the features of this budget type, so I think
it deserves a little time to explain how it's intended to be used.
* update readme and begin img dir restructuring
* fix broken issue board link
* readme edit
* addressed RFCs : #123
* organising images
* more images organised
* more image restructuring
* img reorganisation done
* moved unused imgages to img/unusued and checked if anything broke
* typo
* move favicon and actial imgs back, deleted the rest of unused
* corrections
* img : update accounts image : #85
* doc : fixed formatting and clearer wording : #85
* doc : updated instructions due to new sidebar layout : #85
* img : update images due to new sidebar layout : #85
* doc : updated accounts/addaccount page : #85
- moved all images into their own folder
- grepped the whole repo for their img paths to make sure no other pages were referencing the same images.
- updated img paths in the addaccount page
- updated wording based on new layout / buttons
- simplified other wordings
* img : updated images due to new sidebar layout : #85
- created new folder for backup-restore section
- created new images for 'backup.md'
- deleted old images from 'backup.md'
- updated wording in 'backup.md'
* Fix image sizing
* img : try to half size with @2x, but no change : #85
* doc : implement @2x img resizing and update images : #85
- resized retina screenshots where appropriate
- updated images that showed old sidebar layout
* img : commit missing file : #85
---------
Co-authored-by: Jed Fox <git@jedfox.com>
* Installation Methods
Adding the ability to have additional installation methods in the documentation linked to from external blogs etc.
* Update overview.md
Moved section to replace last paragraph
* Update docusaurus
* Make sure images are in their own paragraph
* Add image handling logic
* oops!
* Fix issues with Image component
* Enable image plugin in dev
* Allow arbitrary scales, remove unused case
* add a note about export from old version of actual
* link to migration info from getting-started
* Update docs/Installing/overview.md
Co-authored-by: Hans Fast <fasthans@gmail.com>
* Update docs/Getting-Started/migration/migration-intro.md
Co-authored-by: Hans Fast <fasthans@gmail.com>
---------
Co-authored-by: Rich Howell <22135084+rich-howell@users.noreply.github.com>
* 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
* Cleared Rules example
* Update docs/Budgeting/rules/rules-custom.md
Thanks!
Co-authored-by: Jed Fox <git@jedfox.com>
* verbage updates
* one more
Co-authored-by: Jed Fox <git@jedfox.com>
