Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 105 additions & 1 deletion _static/dark_mode.css
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,58 @@ body.dark-mode h3,
body.dark-mode h4,
body.dark-mode h5,
body.dark-mode h6 {
color: #ffffff; /* White headings */
color: #ffffff !important; /* White headings */
}

/* More specific rules for content headings */
body.dark-mode .rst-content h1,
body.dark-mode .rst-content h2,
body.dark-mode .rst-content h3,
body.dark-mode .rst-content h4,
body.dark-mode .rst-content h5,
body.dark-mode .rst-content h6 {
color: #ffffff !important; /* White headings in content */
}

/* Fix heading links that inherit link colors */
body.dark-mode .rst-content h1 a,
body.dark-mode .rst-content h2 a,
body.dark-mode .rst-content h3 a,
body.dark-mode .rst-content h4 a,
body.dark-mode .rst-content h5 a,
body.dark-mode .rst-content h6 a {
color: #ffffff !important; /* White heading links */
}

/* Target the specific toc-backref links in headings */
body.dark-mode .rst-content a.toc-backref {
color: #ffffff !important; /* White toc backref links */
}

/* Target headerlink anchors in headings */
body.dark-mode .rst-content a.headerlink {
color: #ffffff !important; /* White header anchor links */
}

/* Even more specific for document section headings */
body.dark-mode .document h1,
body.dark-mode .document h2,
body.dark-mode .document h3,
body.dark-mode .document h4,
body.dark-mode .document h5,
body.dark-mode .document h6 {
color: #ffffff !important; /* White headings in document */
}

body.dark-mode a {
color: #4da8da; /* Light blue links */
}

/* Only apply visited link color to content area, not navigation */
body.dark-mode .rst-content a:visited {
color: #bb86fc; /* Light purple for visited links */
}

body.dark-mode a:hover {
color: #66b3ff; /* Lighter blue on hover */
}
Expand All @@ -47,6 +92,65 @@ body.dark-mode pre {
border: 1px solid #3c3c3c;
}

/* Code blocks in dark mode */
/*.dark-mode .highlight {*/
/* background: #2b2b2b !important;*/
/* border: 1px solid #444 !important;*/
/*}*/

/* Inline code in dark mode */
.dark-mode .rst-content code.literal,
.dark-mode .rst-content tt.literal {
background: #404040 !important;
color: #f8f8f2 !important;
border: 1px solid #555 !important;
padding: 2px 4px !important;
}

/* Syntax highlighting colors for dark mode */
.dark-mode .highlight .c { color: #75715e !important; } /* comments */
.dark-mode .highlight .k { color: #66d9ef !important; } /* keywords */
.dark-mode .highlight .s { color: #e6db74 !important; } /* strings */
.dark-mode .highlight .mi { color: #ae81ff !important; } /* numbers */
.dark-mode .highlight .n { color: #f8f8f2 !important; } /* names */
.dark-mode .highlight .nb { color: #f92672 !important; } /* builtins */
.dark-mode .highlight .nf { color: #a6e22e !important; } /* functions */
.dark-mode .highlight .o { color: #f92672 !important; } /* operators */
.dark-mode .highlight .p { color: #f8f8f2 !important; } /* punctuation */
.dark-mode .highlight .nn { color: #66d9ef !important; } /* imports/namespaces */
.dark-mode .highlight .kn { color: #f92672 !important; } /* import keywords */
.dark-mode .highlight .na { color: #a6e22e !important; } /* attribute names */
.dark-mode .highlight .nc { color: #a6e22e !important; } /* class names */
.dark-mode .highlight .nd { color: #a6e22e !important; } /* decorators */
.dark-mode .highlight .ne { color: #a6e22e !important; } /* exceptions */
.dark-mode .highlight .ni { color: #f92672 !important; } /* name indicators */
.dark-mode .highlight .nl { color: #f92672 !important; } /* name labels */
.dark-mode .highlight .nt { color: #f92672 !important; } /* name tags */
.dark-mode .highlight .nv { color: #f8f8f2 !important; } /* name variables */
.dark-mode .highlight .ow { color: #f92672 !important; } /* operator words */
.dark-mode .highlight .w { color: #f8f8f2 !important; } /* whitespace */
.dark-mode .highlight .mf { color: #ae81ff !important; } /* numbers float */
.dark-mode .highlight .mh { color: #ae81ff !important; } /* numbers hex */
.dark-mode .highlight .mo { color: #ae81ff !important; } /* numbers octal */
.dark-mode .highlight .sb { color: #e6db74 !important; } /* string backtick */
.dark-mode .highlight .sc { color: #e6db74 !important; } /* string char */
.dark-mode .highlight .sd { color: #e6db74 !important; } /* string doc */
.dark-mode .highlight .s2 { color: #e6db74 !important; } /* string double */
.dark-mode .highlight .se { color: #ae81ff !important; } /* string escape */
.dark-mode .highlight .sh { color: #e6db74 !important; } /* string heredoc */
.dark-mode .highlight .si { color: #e6db74 !important; } /* string interpol */
.dark-mode .highlight .sx { color: #e6db74 !important; } /* string other */
.dark-mode .highlight .sr { color: #e6db74 !important; } /* string regex */
.dark-mode .highlight .s1 { color: #e6db74 !important; } /* string single */
.dark-mode .highlight .ss { color: #e6db74 !important; } /* string symbol */


/* Code block container */
/*.dark-mode .rst-content .highlight {*/
/* margin: 1em 0 !important;*/
/*}*/


/* Optional: Style the toggle button */
button {
padding: 8px 16px;
Expand Down
8 changes: 6 additions & 2 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,13 @@
myst_enable_extensions = [
'colon_fence',
'attrs_inline',
'linkify',
'colon_fence'
'linkify'
]

# Configure linkify to only auto-link www.* and https://* patterns
myst_linkify_fuzzy_links = False
myst_url_schemes = ["https", "http"]

master_doc = 'index'

source_suffix = [".md"]
Expand All @@ -51,6 +54,7 @@
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['README.md']
pygments_style = 'default'


# -- Options for HTML output -------------------------------------------------
Expand Down
121 changes: 121 additions & 0 deletions contributor/code/development-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
Getting Started
===============

## Requirements

### Communication in English
Our developers hail from all over the globe, and English is the common language we use to collaborate. You don’t need to be fluent, but you should be comfortable enough to understand and communicate ideas effectively.

If you're reading this, you're likely good to go!

### Familiarity with Git
We use Git as our version control system to manage changes across all projects. It’s a cornerstone of our workflow, so understanding the basics is essential.

If you're new to Git, take a moment to learn it before diving in. Check out the [GitHub Docs](https://docs.github.com/en/get-started/start-your-journey) for a solid introduction. Focus on concepts like commits, branches, remotes, and pull requests.

### A GitHub Account
We host our repositories on GitHub, so you’ll need an account to browse code, fork projects, and submit pull requests. If you don’t have one yet, sign up at [GitHub](https://github.com/) and explore the [GitHub Docs](https://docs.github.com/) to get familiar with the platform.

### Running GhostBSD
For the best experience, run the latest stable version of GhostBSD on your development machine. While older versions or FreeBSD might work, the latest GhostBSD ensures compatibility with our tools and libraries.

You can download the latest ISO from the [GhostBSD website](https://www.ghostbsd.org/download) and install it on a physical machine or a virtual environment.

## Technologies We Use
Here’s a quick rundown of the tools and languages you’ll encounter in GhostBSD development.

### Programming Languages
GhostBSD projects use a mix of languages depending on the task. You don’t need to master them all—just focus on what’s relevant to your interests.

#### Python
Most of our user-facing tools—like NetworkMgr, Update Station, and Software Station—are written in Python. It’s easy to learn, quick to develop with, and widely used in our ecosystem.

#### C
The FreeBSD base system (which GhostBSD builds upon) and many libraries are written in C. It’s a low-level language that requires more effort to work with but delivers excellent performance and deep system access.

#### Bourne Shell (sh)
Many scripts, including build tools like `ghostbsd-build` and utilities like `xconfig`, are written in Bourne shell script. It’s a lightweight way to automate tasks in the FreeBSD ecosystem.

### GUI Toolkit and Libraries
Our graphical applications primarily use the [GTK3 toolkit](https://docs.gtk.org/gtk3/). We rely on GNOME libraries like GLib and GObject, often accessed through Python via [GObject Introspection](https://gi.readthedocs.io/).

#### Configuration Tools
We use `dconf` for storing system configuration. You can interact with it via the `gsettings` command-line tool or the graphical `dconf-editor`.

Install `dconf-editor` for a visual interface:

```shell
sudo pkg install dconf-editor
```

## Setting Up Your Development Environment


Let's get your machine ready for GhostBSD development.

### Install GhostBSD Base System Development Tools

GhostBSD doesn’t come with base system development tools preinstalled. To enable compiling code and ports, install the `GhostBSD*-dev` packages. These include essential build tools, compilers, and libraries:

```shell
sudo pkg install -g 'GhostBSD*-dev'
```

### Create a Development Directory
Organize your work in a dedicated directory. A common spot is your home directory:

```shell
mkdir -p ~/projects/ghostbsd
````

Run cd `~/projects/ghostbsd` to jump in and start cloning repos. This keeps your repositories and files tidy.

### Development Tools
#### Code Editors/IDEs
Pick an editor or IDE you like—there’s no wrong choice! Here are some favorites:

* **PyCharm Community Edition:** Perfect for Python tools like NetworkMgr with built-in linting and debugging.
```shell
sudo pkg install pycharm-ce
```
* `Visual Studio Code:` Lightweight and extensible, great for general-purpose coding.
```shell
sudo pkg install vscode
```
* `Sublime Text:` Fast and minimalist with great plugin support.
```shell
sudo pkg install linux-sublime-text4
```
* `Neovim or Vim:` Lightweight for shell scripts or terminal fans.
```shell
sudo pkg install neovim
```

For Python development, PyCharm stands out with built-in linting. If using another editor, set up a Pylint plugin (e.g., via VS Code’s marketplace or Sublime’s Package Control) to catch issues early. Try one that fits your style!

#### Version Control Tools
We use Git for version control. Beyond the command line, these graphical tools help:

* **gitg:** A GTK-based interface to browse Git history.
```shell
sudo pkg install gitg
cd ~/projects/ghostbsd
git clone https://github.com/ghostbsd/ghostbsd-ports.git
cd ghostbsd-ports
gitg
```
* **Sublime Merge:** A sleek Git client, pairs well with Sublime Text.
```shell
sudo pkg install linux-sublime-merge
```

Clone a repo first (e.g., `git clone https://github.com/ghostbsd/ghostbsd-ports.git`) to explore with these. Many editors also have Git plugins—check yours!

### How to Contribute to GhostBSD

We welcome all contributions! To get started, here's how to jump in:

- **Check the Roadmap**: See our [releases roadmap](https://github.com/orgs/ghostbsd/projects/4) or [current sprint](https://github.com/orgs/ghostbsd/projects/4/views/22) for priorities.
- **Find a Task**: Browse the [issue tracker](https://github.com/orgs/ghostbsd/projects/4/views/21) for bugs or small features, or check [documentation tasks](https://github.com/orgs/ghostbsd/projects/5/views/1) for writing opportunities.
- **Submit Your Work**: Fork the repo, make changes, and send a pull request via GitHub. For docs, contribute to [ghostbsd/documentation](https://github.com/ghostbsd/documentation).
- **Join Us**: Hop into our [Telegram group](https://t.me/ghostbsd_dev) for guidance or to say hi and share what you're working on!
35 changes: 35 additions & 0 deletions contributor/code/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing Code

Welcome to code contribution for GhostBSD! Whether you're interested in Python applications, C system tools, or shell scripts, this section will help you get set up and contributing.

## What We Build

GhostBSD development spans several areas:

### User Applications (Python + GTK3)
Our desktop tools are built with Python and GTK3:
- **NetworkMgr** - Network connection management
- **Update Station** - System update interface
- **Software Station** - Package management GUI
- **System tools** - Various configuration utilities

### System Components (C)
Lower-level system integration with FreeBSD base:
- **Kernel modules** - Hardware support and system features
- **System utilities** - Command-line tools and daemons
- **Libraries** - Shared code for applications

### Build and Configuration (Shell)
Automation and system configuration:
- **ghostbsd-build** - ISO building system
- **Installation scripts** - System setup and configuration
- **Package building** - Port compilation and packaging

## Getting Started with Code

- [Development Environment Setup](development-setup) – Set up your development machine and tools
- [Python Development Guide](python-guide) – Contributing to our GTK3 applications
- [C Development Guide](c-guide) – Working with system components
- [Shell Scripting Guide](shell-guide) – Build tools and configuration scripts
- [Testing and QA](testing) – How to test your changes
- [Code Standards](standards) – Coding style and best practices
5 changes: 5 additions & 0 deletions contributor/community/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Community Involvement

Get involved in the GhostBSD community! Whether you're providing user support, participating in development discussions, or helping newcomers, community involvement is a valuable way to contribute to GhostBSD.

- [Users Support](users-support.md) - Help other GhostBSD users by answering questions and providing support
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h1>Users Support</h1>
# Users Support

Helping other users is a great way to contribute back, and it helps developers to focus on working on GhostBSD bugs and new features. Anyone with reasonable Linux/BSD experience and English skills can help.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Documentation Contribution
==========================
# Getting Started with Documentation

Writing documentation is a great way to start improving GhostBSD user experience and you will be helping a lot of GhostBSD users to better understand their desktop and applications. Anyone with reasonable English skills and good knowledge of FreeBSD, GhostBSD or MATE can help.
Ready to contribute to GhostBSD documentation? This guide will help you get started with writing, editing, and improving our documentation to make GhostBSD more accessible to everyone.

Writing documentation is a great way to start improving GhostBSD user experience, and you will be helping a lot of GhostBSD users to better understand their desktop and applications. Anyone with reasonable English skills and good knowledge of FreeBSD, GhostBSD or MATE can help.

## Communicating with the team

Expand All @@ -14,7 +15,7 @@ Those three messaging platform are connected together. So whatever you use IRC,

## Getting the resources

In order to document GhostBSD projects, you will want to run a [recent GhostBSD build](https://www.ghostbsd.org/download#latest_builds), and to document third-party projects, you will also need a recent version of that program. We are use [Sphinx](https://www.sphinx-doc.org) with [MyST](https://myst-parser.readthedocs.io) to makes it easy to create our Documentation Hub. Any one that wants to help should start to be familiar with [Git](getting-started/getting-started.md#knowing-how-to-use-git), [GitHub](getting-started/getting-started.md#knowing-how-to-use-github) and [MyST Markdown syntax](https://myst-parser.readthedocs.io/en/latest/intro.html).
To document GhostBSD projects, you will want to run a [recent GhostBSD build](https://www.ghostbsd.org/download#latest_builds), and to document third-party projects, you will also need a recent version of that program. We are use [Sphinx](https://www.sphinx-doc.org) with [MyST](https://myst-parser.readthedocs.io) to makes it easy to create our Documentation Hub. Any one that wants to help should start to be familiar with [Git](getting-started/getting-started.md#knowing-how-to-use-git), [GitHub](getting-started/getting-started.md#knowing-how-to-use-github) and [MyST Markdown syntax](https://myst-parser.readthedocs.io/en/latest/intro.html).

The instructions for install and setup can be found on the [GhostBSD Documentation GitHub](https://github.com/ghostbsd/documentation#local-development-server) repository.

Expand Down
7 changes: 7 additions & 0 deletions contributor/documentation/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Contributing Documentation

Welcome to the GhostBSD documentation contribution guide! Help us improve and expand our documentation to make GhostBSD more accessible to users and contributors.

- [Getting Started with Documentation](getting-started.md) - Learn how to contribute to GhostBSD documentation

This section covers the complete process of writing, editing, and maintaining GhostBSD documentation, from initial setup through publication.
Loading