Documentation/content/improving-documentation/index.md
Javier Pérez c6ac9a9f94 Reduce line length limit and format content (#623)
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Changed

- Update line length limit from 500 characters to 120 characters.

## Fixed

- Most instances of these lint issues:
  1. Lines longer than 120 characters ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md)).
  2. Trailing whitespaces ([MD009](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md)).
  3. Ordered list item prefix ([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md)).
  4. Bare links ([MD034](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md)).

Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/623
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-06-14 11:38:21 +02:00

42 lines
1.4 KiB
Markdown

---
eleventyNavigation:
key: ImprovingTheDocumentation
title: Improving the Documentation
icon: book
order: 76
---
We're very happy you're considering to contribute to Codeberg Documentation!
{% assign navPages = collections.all | eleventyNavigation %}
{%- for entry in navPages %}
{% if entry.url == page.url %}
{%- if entry.children.length -%}
<table class="table">
<thead>
<th> Find out more in this section: </th>
</thead>
<tbody>
{%- for child in entry.children %}
<tr><td>
<a href="{{ child.url }}">{{ child.title }}</a>
</tr></td>
{%- endfor %}
</tbody>
</table>
{% endif %}
{% endif %}
{%- endfor %}
### How do I contribute to Codeberg Documentation?
To contribute to Codeberg Documentation, the first thing you should do (if you haven't already done it) is to create
your own fork of the [Codeberg/Documentation repository](https://codeberg.org/Codeberg/Documentation).
Then, for each major contribution that you want to make (e.g. for each new article), create a new branch, make your
contributions and finally make a Pull Request to the Codeberg/Documentation repository.
You can find the source code to all articles in the `content` directory of Codeberg Documentation's source tree.
The Codeberg Documentation collaborators will then review your pull request, they may request some changes and
eventually, once all is good, they may merge your contribution into the official repository and deploy it to the live site.