Quick whip through to try and standardis(z)e some language, looks like
the most common English in the docs is US English so I chose that one,
but if we'd prefer the Queen's then that's okay too.
---------
Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
add some basic guidelines about how to write the docs so a shared voice is heard when using the documentation.
---------
Co-authored-by: Zeus\Herb <herb@win.dows>
Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
update the readme to have more of a present date, clean up various small
grammar and formatting throughout the page.
clarify that the docs donʻt have release notes written in the same way
as the rest of the project. include information about what makes it to
the git commit messages to encourage people to write good PRs.
add note that screenshots should be taken in light mode
Notes and edits welcome.
---------
Co-authored-by: Zeus\Herb <herb@win.dows>
Linked to contributing docs, replacing detail. This can't be merged
until after #176 gets merged though as the build will fail due to broken
links.
---------
Co-authored-by: Jed Fox <git@jedfox.com>
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`)
* 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
* 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
