Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1909 - update documentation #1912

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

1909 - update documentation #1912

wants to merge 1 commit into from

Conversation

Cmdv
Copy link
Contributor

@Cmdv Cmdv commented Nov 29, 2024

Description

Just making our documentations a little clearer to find and go through for our users.

this fixes #1909

Checklist

  • Commit sequence broadly makes sense
  • Commits have useful messages
  • New tests are added if needed and existing tests are updated
  • Any changes are noted in the changelog
  • Code is formatted with fourmolu on version 0.10.1.0 (which can be run with scripts/fourmolize.sh)
  • Self-reviewed the diff

Migrations

  • The pr causes a breaking change of type a,b or c
  • If there is a breaking change, the pr includes a database migration and/or a fix process for old values, so that upgrade is possible
  • Resyncing and running the migrations provided will result in the same database semantically

If there is a breaking change, especially a big one, please add a justification here. Please elaborate
more what the migration achieves, what it cannot achieve or why a migration is not possible.

@Cmdv Cmdv requested a review from a team as a code owner November 29, 2024 13:00
@Cmdv Cmdv changed the title 1909 update documentation 1909 - update documentation Dec 4, 2024
kderme
kderme previously approved these changes Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add README to doc/
2 participants