Add GhostBSD versioning guide and src maintenance documentation#90
Merged
Add GhostBSD versioning guide and src maintenance documentation#90
Conversation
- 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)
Contributor
Reviewer's GuideThis 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
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
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
- 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`.
Member
Author
|
@sourcery-ai review |
Contributor
There was a problem hiding this comment.
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.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Enhancements:
Build:
Chores: