Skip to content

Conversation

ericbsd
Copy link
Member

@ericbsd ericbsd commented Sep 6, 2025

Description of Changes

  • Simplified and clarified the "Development Setup" guide.
  • Ensured prerequisites are linked and easily accessible for contributors.
  • Reorganized "Getting Started" and "Documentation Setup" sections to improve readability.
  • Added detailed steps for configuring the documentation environment.
  • Enhanced navigation with improved cross-references within contributor materials.

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:

  • Standardize references to latest GhostBSD release and streamline terminology throughout contributor materials

Documentation:

  • Simplify and reorganize the code and documentation setup guides with clear prerequisite sections and introductory overviews
  • Add step-by-step instructions for configuring the local documentation environment (clone, install dependencies, run server, view changes)
  • Enhance getting-started index pages with explicit links to development setup, contributor requirements, and improved navigation across sections

…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.
@ericbsd ericbsd requested review from a team as code owners September 6, 2025 20:28
Copy link
Contributor

sourcery-ai bot commented Sep 6, 2025

Reviewer's Guide

This 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

Change Details Files
Restructure and clarify documentation Getting Started guide
  • Introduce a consolidated Prerequisites section linking general contributor requirements
  • Rewrite team communication to a single Telegram link
  • Refine resource guidance to focus on GhostBSD releases and MyST syntax
  • Add a new ‘Setting up the Documentation Environment’ section with step-by-step clone, install, build, and preview commands
  • Adjust beginner tasks list for consistency
contributor/documentation/getting-started.md
Simplify and rename the Development Environment Setup guide
  • Rename guide to “Development Environment Setup” and replace verbose requirements with a prereq link
  • Collapse multiple requirement subsections into a single Prerequisites reference
  • Streamline installation commands into grouped pkg install calls
  • Clarify purpose of ghostbsd-devel-tools vs GhostBSD-dev packages
contributor/code/development-setup.md
Enhance navigation in top-level contributor and code indexes
  • Insert a ‘Requirements for All Contributors’ section with English, Git/GitHub, and GhostBSD recommendations
  • Add and emphasize ‘Development Setup’ link under code contributions
  • Reorder items to surface development setup first
  • Label the code index ‘First Steps’ and stress starting point
contributor/getting-started/index.md
contributor/code/index.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a 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>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ericbsd ericbsd merged commit be15ad5 into master Sep 6, 2025
4 checks passed
@ericbsd ericbsd deleted the improve-dev-docs branch September 6, 2025 20:31
@github-project-automation github-project-automation bot moved this from In Review to Done in Documentation Management Sep 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant