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.

Sign up for GitHub

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

Jump to bottom

chore: more detailed docs #54

Merged
merged 6 commits into from
Aug 13, 2024
Merged

chore: more detailed docs #54

merged 6 commits into from
Aug 13, 2024

Conversation

kayra1
Copy link
Contributor

@kayra1 kayra1 commented Aug 13, 2024 •
edited
Loading

Description

This PR improves the documentation so that following all of the commands in the readme results in a working application.

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

@kayra1 kayra1 changed the title chore: More detailed docs chore: more detailed docs Aug 13, 2024
@kayra1 kayra1 marked this pull request as ready for review August 13, 2024 10:56
@kayra1 kayra1 requested a review from a team as a code owner August 13, 2024 10:56
@kayra1 kayra1 merged commit 1b37388 into main Aug 13, 2024
17 checks passed
@kayra1 kayra1 deleted the docs branch August 13, 2024 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ghislainbourgeois ghislainbourgeois ghislainbourgeois approved these changes

@saltiyazan saltiyazan saltiyazan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kayra1 @ghislainbourgeois @saltiyazan