Skip to content

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

Merged
merged 1 commit into from
Mar 23, 2025
Merged

Reworking getting-started #83

merged 1 commit into from
Mar 23, 2025

Conversation

ericbsd
Copy link
Member

@ericbsd ericbsd commented Mar 23, 2025

Summary by Sourcery

Restructures the contributor documentation, adds a getting started guide, and updates documentation links.

New Features:

  • Introduces a 'Getting Started' guide for new contributors, outlining requirements, technologies, and setup instructions.
  • Adds a comprehensive contributor documentation index page.
  • Adds a link to the releases roadmap and current sprint to the 'How to Contribute' section of the 'Getting Started' guide.
  • Adds a link to documentation tasks to the 'How to Contribute' section of the 'Getting Started' guide.
  • Adds a link to the Telegram group to the 'How to Contribute' section of the 'Getting Started' guide.

@ericbsd ericbsd requested review from a team as code owners March 23, 2025 00:46
Copy link
Contributor

sourcery-ai bot commented Mar 23, 2025

Reviewer's Guide by Sourcery

This 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

Change Details Files
Introduced a new 'Getting Started' guide for contributors.
  • Added a new page with information on how to get started contributing to GhostBSD.
  • Defined requirements for contributors, such as communication in English, familiarity with Git, and a GitHub account.
  • Recommended running GhostBSD for development.
  • Listed technologies used in GhostBSD development, including Python, C, and Bourne shell.
  • Provided instructions for setting up a development environment, including installing development tools and creating a development directory.
  • Suggested code editors and IDEs.
  • Explained how to contribute to GhostBSD.
contributor/getting-started/index.md
Updated the contributor index page to include the new 'Getting Started' guide.
  • Added a link to the new 'Getting Started' guide in the contributor index page.
contributor/index.md
Updated documentation contribution guides to link to the new 'Getting Started' guide.
  • Modified the documentation contribution guides to reference the new 'Getting Started' guide for Git and GitHub information.
contributor/documentation.md
contributor/documentation-pl.md
Renamed 'Junior Contributors' to 'New Contributors' in the contributor levels documentation.
  • Changed the title of the 'Junior Contributors' section to 'New Contributors'.
contributor/contributor-levels.md
Removed outdated or redundant files.
  • Deleted the old 'getting-started.md' and 'getting-started-pl.md' files.
contributor/getting-started-pl.md
contributor/getting-started.md
Updated the main index page to reflect changes in the contributor documentation.
  • Updated the toctree directive to include the new 'Getting Started' guide and the contributor index.
  • Reduced the maximum depth of the toctree directives.
index.md
Fixed inline code background in dark mode.
  • Added CSS rules to set the background color and border radius for inline code elements in dark mode.
_static/dark_mode.css
Excluded README.md from Sphinx processing.
  • Added README.md to the exclude_patterns list in conf.py.
conf.py

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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 @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 in toctree 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

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 cd3ba1f into master Mar 23, 2025
4 checks passed
@ericbsd ericbsd deleted the Getting-started branch March 23, 2025 00:51
@github-project-automation github-project-automation bot moved this from In Review to Done in Documentation Management Mar 23, 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