-
Notifications
You must be signed in to change notification settings - Fork 29
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
Adding a link to NETWORK.md from the main README.md #726
Conversation
Reviewer's Guide by SourceryThis pull request adds a link to the NETWORK.md file in the README.md file. This change was requested by @dougsland from ticket. The section placement was discussed and agreed upon. The table of contents and the numbering of the subsequent sections were updated to reflect the addition of the new link. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Hey @nsednev - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider using a relative link for
NETWORK.md
instead of an absolute URL.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Signed-off-by: nsednev <[email protected]>
cb8b175
to
9b95597
Compare
This MR was requested by @dougsland from ticket.
Its just about adding a link to NETWORK.md from the main README.md.
The section placement was discussed and agreed.
Summary by Sourcery
Documentation: