Skip to content

documentation/index.md: Correct grammar and spelling for clarity#97

Merged
ericbsd merged 2 commits into
ghostbsd:masterfrom
wmthornton-dev:documentation-update
Jun 3, 2026
Merged

documentation/index.md: Correct grammar and spelling for clarity#97
ericbsd merged 2 commits into
ghostbsd:masterfrom
wmthornton-dev:documentation-update

Conversation

@wmthornton-dev

@wmthornton-dev wmthornton-dev commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Fixed minor grammatical errors and spelling for clarity.

Summary by Sourcery

Documentation:

  • Refine the GhostBSD overview paragraph in the main documentation index to fix grammar and improve readability.

@wmthornton-dev wmthornton-dev requested review from a team as code owners June 3, 2026 13:36
@sourcery-ai

sourcery-ai Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR refines the introductory documentation text by tightening phrasing, fixing a run-on comparison clause, and clarifying how the installer leverages OpenZFS, all within index.md.

File-Level Changes

Change Details Files
Improve clarity and grammar in the introductory description of GhostBSD in the documentation index.
  • Adjusted the clause contrasting GhostBSD’s slow-rolling release with bleeding-edge GNU/Linux distributions to remove an awkward phrase and fix punctuation.
  • Clarified the sentence about the installer leveraging OpenZFS by explicitly connecting OpenZFS to ease of installation and suitability for newcomers.
  • Kept the overall structure and content of the overview paragraph intact while making small textual corrections only.
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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="index.md" line_range="8" />
<code_context>
+GhostBSD is a simple, elegant, and friendly BSD operating system for desktops and laptops based on FreeBSD. GhostBSD is a slow-rolling release while some GNU/Linux distros are on the bleeding edge; we tried to offer a stable update and release cycle. The official desktop environment is MATE. The system comes with a graphical application to install software and update your system. Most codecs to play multimedia files are pre-installed. The installer leverages OpenZFS which makes it easy to install and is suitable for newcomers to BSD. With modest hardware requirements, GhostBSD is ideal for modern workstations and 64-bit single-board computer hardware.
</code_context>
<issue_to_address>
**suggestion (typo):** Consider adding a comma before "while" and aligning the tense in "we tried" with the rest of the paragraph.

To keep things present-tense and flowing, you could rephrase this sentence as: "GhostBSD is a slow-rolling release, while some GNU/Linux distros are on the bleeding edge; we try to offer a stable update and release cycle."

```suggestion
GhostBSD is a simple, elegant, and friendly BSD operating system for desktops and laptops based on FreeBSD. GhostBSD is a slow-rolling release, while some GNU/Linux distros are on the bleeding edge; we try to offer a stable update and release cycle. The official desktop environment is MATE. The system comes with a graphical application to install software and update your system. Most codecs to play multimedia files are pre-installed. The installer leverages OpenZFS which makes it easy to install and is suitable for newcomers to BSD. With modest hardware requirements, GhostBSD is ideal for modern workstations and 64-bit single-board computer hardware.
```
</issue_to_address>

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.

Comment thread index.md Outdated
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

@ericbsd ericbsd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Thanks for your grammar and spelling correction contribution!

@github-project-automation github-project-automation Bot moved this from In Review to In Progress in Documentation Management Jun 3, 2026
@ericbsd ericbsd merged commit 03dfd85 into ghostbsd:master Jun 3, 2026
2 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Documentation Management Jun 3, 2026
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.

3 participants