-
Notifications
You must be signed in to change notification settings - Fork 16
Reworking getting-started #83
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
Conversation
Reviewer's Guide by SourceryThis pull request introduces a new 'Getting Started' guide for contributors, updates the contributor index page, and makes several other documentation improvements. It also includes a fix for inline code background in dark mode and excludes README.md from Sphinx processing. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
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 @ericbsd - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a brief description or summary at the beginning of each
.md
file to provide context. - The
maxdepth
intoctree
was changed to 2, is this intentional and are you sure this is the desired depth?
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 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.
Summary by Sourcery
Restructures the contributor documentation, adds a getting started guide, and updates documentation links.
New Features: