Skip to content

Conversation

ericbsd
Copy link
Member

@ericbsd ericbsd commented Jul 19, 2025

  • Add comprehensive GhostBSD Versioning Guide covering release numbering, version schemes, and release cycle management
  • Add maintaining GhostBSD src from FreeBSD src documentation with merge procedures and conflict resolution
  • Create maintenance-release/ section for release management documentation
  • Restructure contributor docs into logical sections:
    • code/ for development and setup
    • community/ for user support and engagement
    • documentation/ for writing and editing guides
    • maintenance-release/ for release and maintenance processes
  • Move existing files to new structure and update cross-references
  • Remove duplicate content (merged get-involved into getting-started)

Summary by Sourcery

Reorganize and expand GhostBSD contributor docs by adding versioning and src maintenance guides, restructuring sections, refining dark mode styling, and updating build dependencies and Sphinx configuration.

New Features:

  • Add GhostBSD Versioning Guide documenting version numbering, format, and release lifecycle
  • Add guide for maintaining GhostBSD src from FreeBSD src with branching, merge, and conflict resolution procedures

Enhancements:

  • Restructure contributor documentation into code/, community/, documentation/, and maintenance-release/ sections with updated navigation
  • Enhance dark_mode.css with precise styling rules for headings, links, inline code, and syntax highlighting in dark mode

Build:

  • Update requirements.txt to include linkify-it-py and sphinx-autobuild

Chores:

  • Update Sphinx conf.py to fine-tune linkify behavior and set pygments_style
  • Move and rename contributor docs, update cross-references, and remove duplicate get-involved content

- Add comprehensive GhostBSD Versioning Guide covering release numbering,
  version schemes, and release cycle management
- Add maintaining GhostBSD src from FreeBSD src documentation with
  merge procedures and conflict resolution
- Create maintenance-release/ section for release management documentation
- Restructure contributor docs into logical sections:
  - code/ for development and setup
  - community/ for user support and engagement
  - documentation/ for writing and editing guides
  - maintenance-release/ for release and maintenance processes
- Move existing files to new structure and update cross-references
- Remove duplicate content (merged get-involved into getting-started)
@ericbsd ericbsd requested review from a team as code owners July 19, 2025 02:48
Copy link
Contributor

sourcery-ai bot commented Jul 19, 2025

Reviewer's Guide

This PR introduces a dedicated maintenance-release section with detailed versioning and src‐maintenance guides, reorganizes contributor documentation into clear thematic directories, refines Sphinx configuration and dependencies, and significantly enhances dark mode CSS styling.

Flow diagram for GhostBSD src maintenance process (new documentation)

flowchart TD
    A[Clone ghostbsd-src repo]
    B[Add freebsd-src as remote]
    C[Update main branch]
    D[Create merge branch]
    E[Merge from FreeBSD branch]
    F[Resolve conflicts]
    G[Test build]
    H[Push merge branch]
    I[Create PR to main/stable/releng]

    A --> B --> C --> D --> E --> F --> G --> H --> I
Loading

Flow diagram for GhostBSD versioning and release process (new documentation)

flowchart TD
    A[Update to new FreeBSD base]
    B[Integrate/test GhostBSD features]
    C[Update sys/conf/package-version]
    D[Build and test system]
    E[Release with new version number]

    A --> B --> C --> D --> E
Loading

File-Level Changes

Change Details Files
Add comprehensive maintenance‐release documentation for versioning and source maintenance
  • Created a GhostBSD Versioning Guide outlining the YY.PP.R##.#p# scheme
  • Added a step-by-step Maintaining GhostBSD Src guide for syncing with FreeBSD
  • Introduced a maintenance-release index to tie together ports, src, and versioning workflows
contributor/maintenance-release/versioning-guide.md
contributor/maintenance-release/maintaining-src-tree.md
contributor/maintenance-release/index.md
Restructure contributor docs into logical sections and update cross-references
  • Organized docs under code/, community/, documentation/, and maintenance-release/ directories
  • Moved and renamed getting-started, documentation, and code setup files to new paths
  • Updated root and contributor index navigation links and removed duplicate get-involved content
contributor/index.md
index.md
contributor/getting-started/index.md
contributor/documentation/getting-started.md
contributor/code/index.md
contributor/code/development-setup.md
contributor/documentation/index.md
contributor/community/index.md
Refine Sphinx configuration and update documentation dependencies
  • Disabled fuzzy linkify and restricted URL schemes in conf.py
  • Set a default pygments style for syntax highlighting
  • Added linkify-it-py and sphinx-autobuild to requirements.txt
conf.py
requirements.txt
Enhance dark mode CSS rules for clarity and consistency
  • Enforced white headings and links with !important for all content contexts
  • Styled inline code and syntax highlighting classes for dark backgrounds
  • Scoped visited link color and refined heading anchor/link styling
_static/dark_mode.css

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 @ericbsd - I've reviewed your changes and they look great!


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 added 2 commits July 19, 2025 08:50
- Deleted outdated "Get Involved" and "Zaangażuj się" contributor pages
- Clarified title formatting in "Maintaining GhostBSD Src from FreeBSD Src" doc
- Improved file structure in translation documentation for clarity.
- Expanded dark mode CSS with specific rules for headings, links, and syntax highlighting.
- Updated `conf.py` to configure `linkify` and added `pygments_style` for syntax highlighting.
- Added `sphinx-autobuild` and reorganized requirements in `requirements.txt`.
@ericbsd
Copy link
Member Author

ericbsd commented Jul 19, 2025

@sourcery-ai review

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:

  • The new dark_mode.css is quite verbose—consider refactoring duplicate selectors and removing commented‐out rules to improve maintainability.
  • After reorganizing the contributor docs, double-check that all internal links and redirects still work so there are no broken references.
  • There are multiple 'Getting Started' pages under different sections (general, code, docs); consider consolidating or pointing to a single canonical guide to avoid content duplication.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The new dark_mode.css is quite verbose—consider refactoring duplicate selectors and removing commented‐out rules to improve maintainability.
- After reorganizing the contributor docs, double-check that all internal links and redirects still work so there are no broken references.
- There are multiple 'Getting Started' pages under different sections (general, code, docs); consider consolidating or pointing to a single canonical guide to avoid content duplication.

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 8baca5a into master Jul 19, 2025
1 check passed
@ericbsd ericbsd deleted the src-maintenance branch July 19, 2025 19:44
@github-project-automation github-project-automation bot moved this from In Review to Done in Documentation Management Jul 19, 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