Contributing

Contributions are welcome! If you want to help improve this guide and its content, this page will help you set up a local development environment to edit the documentation.

Local Development

This documentation website is built using Zola, a static site generator (SSG) and template engine.

Getting Started

Fork the Repository

Start by creating a fork of the repository on Codeberg: affinity-wine-docs.

Clone the Repository Locally

Clone your forked version of the repository to your local machine:

git clone https://codeberg.org/(your-username)/affinity-wine-docs.git

cd affinity-wine-docs

Create a Branch for Your Changes

To keep your changes organized and separate from the main codebase, create a new branch with a descriptive name:
```
git checkout -b my_feature_branch
```
Replace my_feature_branch with a short, descriptive name that reflects the purpose of your changes.
Install Zola

You can find information about how to install zola on you distro on the installation page of it's documentation.
Start the Development Server

After installing Zola, start the development server:
```
zola serve
```
If you decide to modify more than just markdown files you should familiazize yourself with Zola by reading it's documentation.
Make Your Changes

If you're adding a new page, make sure your changes are also adding the frontmatter correctly and by following the naming scheme to ensure they are properly linked in the documentation.
Test Your Changes Locally

Open a web browser and navigate to the local development server URL to verify that your changes render correctly. Check for broken links, formatting issues, or any other errors.
Commit and Push Your Changes

Once you're satisfied with your changes, commit them with a descriptive message and push them to your fork on Codeberg:
```
git commit -m "Add new feature: improve documentation for X"
```
```
git push my_feature_branch
```
Replace my_feature_branch with the name of your branch and provide a meaningful commit message.
Create a Pull Request

Go to the Codeberg repository and create a pull request. Ensure your pull request clearly describes the changes you've made and why they are beneficial.

By following these steps, you will be able to contribute to the documentation. Thank you for helping this guide improve!