-
-
Notifications
You must be signed in to change notification settings - Fork 16
Revise contributor documentation for clarity and cohesion #94
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
…ibuting guides - Simplified the "Development Setup" guide for clarity and reduced redundancy. - Linked relevant prerequisites to ensure contributors meet essential requirements upfront. - Reorganized sections within "Getting Started" and "Documentation Setup" for better readability. - Added step-by-step instructions for configuring the documentation environment. - Improved cross-references between contributor guides to enhance navigation.
Reviewer's GuideThis PR revises contributor-facing documentation by restructuring prerequisite and setup sections for clarity, streamlining instructions in the Development Setup guide, and enhancing navigation across contributor index pages. 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 there - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `contributor/documentation/getting-started.md:45` </location>
<code_context>
+You can get your first contribution committed today! Here are some tasks for beginners:
* Read the documentation if there is a grammar issue, fix it
* Improve the sentences and paragraphs
* Update ScreenShots and Documentation
</code_context>
<issue_to_address>
Typo: 'ScreenShots' should be 'screenshots'.
Please update 'ScreenShots' to 'screenshots' for consistency.
</issue_to_address>
<suggested_fix>
<<<<<<< SEARCH
* Update ScreenShots and Documentation
=======
* Update screenshots and Documentation
>>>>>>> REPLACE
</suggested_fix>
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Description of Changes
Summary by Sourcery
Restructure and clarify the GhostBSD contributor documentation by adding explicit prerequisites, consolidating communication and setup instructions, and improving cross-references across guide indices.
Enhancements:
Documentation: