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

docs: restructure following diataxis #110

Merged
merged 6 commits into from
Oct 9, 2024
Merged

docs: restructure following diataxis #110

merged 6 commits into from
Oct 9, 2024

Conversation

gruyaume
Copy link
Collaborator

@gruyaume gruyaume commented Oct 8, 2024

Description

At the moment, the project's README.md serves as our official documentation. Here, we restructure the file so that it follows diataxis standards.

We also adapt the CONTRIBUTING.md to follow the same format with a clear and complete getting started tutorial.

Reference

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that validate the behaviour of the software
  • I validated that new and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Signed-off-by: Guillaume Belanger <[email protected]>
@gruyaume gruyaume requested a review from a team as a code owner October 8, 2024 16:17
Signed-off-by: Guillaume Belanger <[email protected]>
@gruyaume gruyaume changed the title docs: restructure README.md following diataxis standards docs: restructure README.md following diataxis Oct 8, 2024
@gruyaume gruyaume changed the title docs: restructure README.md following diataxis docs: restructure following diataxis Oct 8, 2024
@gruyaume gruyaume merged commit ac616e6 into main Oct 9, 2024
15 checks passed
@gruyaume gruyaume deleted the dev-diataxis branch October 9, 2024 10:46
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.

2 participants