Contributing

Contributions are welcome! If you want to help with the wine fork you can visit the forum and/or ElementalWarrior's fork to fork and improve upon.

However 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 VuePress, a static site generator powered by Vue.js.

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
```
Install a Node Package Manager
You will need a Node package manager to handle dependencies, i prefer pnpm. But you can use any of the following:
- pnpm
- yarn
- npm
Install the required dependencies by running the appropriate command in the root directory of the cloned repository:
```
pnpm install
```
```
yarn install
```
```
npm install
```
Start the Development Server
After installing the dependencies, start the development server with the relevant command. Pay close attention to any messages in the terminal, as they will inform you of broken links or other issues that need fixing.
```
pnpm docs:dev
```
```
yarn docs:dev
```
```
npm docs:dev
```
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.
Make Your Changes
If you're adding a new page, make sure your changes are also reflected in the sidebar configuration file .vuepress/configs/sidebar/index.ts 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!