docs: Improve README and intro #189
Merged
Conversation
This file contains hidden or 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
Contributor
llucax
commented
Sep 18, 2023
llucax
commented
- Add an intro and install instructions
- Improve the README introduction
- Add a quick start section to the README
- Add a documentation section to the README
We also remove the `README.md` from the files to watch by `mkdocs` because it is not included anymore in the documentation. Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
github-actions
bot
added
part:docs
Contributor
daniel-zullo-frequenz
left a comment
daniel-zullo-frequenz
left a comment
There was a problem hiding this comment.
Only a comment to check for, LGTM otherwise
Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
llucax
force-pushed
the
improve-docs
branch
from
520deca to
d9961e2
Compare
daniel-zullo-frequenz
approved these changes
Sep 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.