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
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
9 changes: 8 additions & 1 deletion _static/dark_mode.css
Original file line number Diff line number Diff line change
Expand Up @@ -187,4 +187,11 @@ body.dark-mode .wy-menu-vertical li.toctree-l3.current {
/* Ensure the <a> inside li.toctree-l3.current does not override the background */
body.dark-mode .wy-menu-vertical li.toctree-l3.current a {
background-color: transparent !important;
}
}

/* Fix inline <code> background in dark mode */
body.dark-mode code.docutils.literal.notranslate {
background-color: #232323; /* Match your <pre> background */
border-radius: 3px;
border-color: #3c3c3c;
}
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
exclude_patterns = ['README.md']


# -- Options for HTML output -------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion contributor/contributor-levels.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
GhostBSD Contributor Levels
===========================

## 1. Junior Contributors
## 1. New Contributors
**Description:** New members who are actively contributing to the project.

**Access and Permissions:** Access to public repositories with full capabilities to create branches and submit pull requests.
Expand Down
2 changes: 1 addition & 1 deletion contributor/documentation-pl.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Te trzy platformy komunikacyjne są ze sobą połączone. Bez względu na to, cz

## Uzyskiwanie zasobów

Aby dokumentować projekty GhostBSD, warto uruchomić [najnowszą wersję GhostBSD](https://www.ghostbsd.org/download#latest_builds), a do dokumentowania projektów innych firm potrzebna będzie również najnowsza wersja tego programu. Używamy [Sphinx](https://www.sphinx-doc.org) z [MyST](https://myst-parser.readthedocs.io), co ułatwia tworzenie naszego Centrum Dokumentacji. Każdy, kto chce pomóc, powinien zacząć zapoznawać się z [Git](getting-started.md#knowing-how-to-use-git), [GitHub](getting-started.md#knowing-how-to-use-github) i [MyST Markdown syntax](https://myst-parser.readthedocs.io/en/latest/intro.html).
Aby dokumentować projekty GhostBSD, warto uruchomić [najnowszą wersję GhostBSD](https://www.ghostbsd.org/download#latest_builds), a do dokumentowania projektów innych firm potrzebna będzie również najnowsza wersja tego programu. Używamy [Sphinx](https://www.sphinx-doc.org) z [MyST](https://myst-parser.readthedocs.io), co ułatwia tworzenie naszego Centrum Dokumentacji. Każdy, kto chce pomóc, powinien zacząć zapoznawać się z [Git](getting-started/getting-started.md#knowing-how-to-use-git), [GitHub](getting-started/getting-started.md#knowing-how-to-use-github) i [MyST Markdown syntax](https://myst-parser.readthedocs.io/en/latest/intro.html).

Instrukcje dotyczące instalacji i konfiguracji można znaleźć w repozytorium [GhostBSD Documentation GitHub](https://github.com/ghostbsd/documentation#local-development-server).

Expand Down
5 changes: 3 additions & 2 deletions contributor/documentation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<h1>Documentation Contribution</h1>
Documentation Contribution
==========================

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.

Expand All @@ -13,7 +14,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.md#knowing-how-to-use-git), [GitHub](getting-started.md#knowing-how-to-use-github) and [MyST Markdown syntax](https://myst-parser.readthedocs.io/en/latest/intro.html).
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).

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
190 changes: 0 additions & 190 deletions contributor/getting-started-pl.md

This file was deleted.

Loading