-
Notifications
You must be signed in to change notification settings - Fork 48
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
Update README.md #199
base: main
Are you sure you want to change the base?
Update README.md #199
Conversation
Add overview of repositories
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, thank you!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for taking the time to add this, just some minor comments about placement.
The [build] job seems to fail because of an outdated action in use:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Only a minor question.
## How Chisel works | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we remove this, now that this is not part of the section with the repositories?
## Chisel repositories | ||
|
||
- [chisel](https://github.com/canonical/chisel) - main repository of the project | ||
- [chisel-docs](https://github.com/canonical/chisel-docs) - documentation repository |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, what is the scope of this PR in regards to adding a link to https://documentation.ubuntu.com/chisel/? Are we doing it later or somewhere else?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Y I'd do that later, once we have a version of the docs that covers everything (and more) from this README
Add overview of repositories to README to help contributors orient in the project setup.