Docs: Updated all markdown files with project documentation #17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Natalia Luzuriaga <[email protected]>
Signed-off-by: Natalia Luzuriaga <[email protected]>
natalialuzuriaga
requested review from
IsaacMilarky,
DinneK,
sachin-panayil and
decause-gov
|
Fixes #15 |
DinneK
reviewed
Jan 24, 2025
| - Please try to keep pull requests to a reasonable size; try to split large contributions to multiple PRs | ||
| - Please create pull requests into dev unless the contribution is some kind of bugfix or urgent hotfix. | ||
| - Document and explain the contribution clearly according to provided standards when possible. | ||
| - Feel free to reach out to us if there is any confusion. A list of the project maintainers is found here: [MAINTAINERS.md](./MAINTAINERS.md) |
There was a problem hiding this comment.
Lines 25, 28 do not have periods, lines 26, 27 do have periods. Should these be consistent?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Now that the MVP is completed and we are preparing for a release, documentation needs to be updated.
Solution
Updated the following documents:
Also added a PR template