Contributing

Prerequisites

• Node.js (built with v24)
• NPM
• Git

Installation

1. Clone the repository:

   git clone https://github.com/Termix-SSH/Docs

2. Install the dependencies:

   npm install

Running the development server

Run the following command:

npm run docs:dev

This will start the frontend server. You can access Docs by going to http://localhost:5173/.

Contributing

1. Fork the repository: Click the "Fork" button at the top right of the repository page.
2. Create a new branch:

   git checkout -b feature/my-new-feature

3. Make your changes: Implement your feature, fix, or improvement.
4. Commit your changes:

   git commit -m "Feature request my new feature"

5. Push to your fork:

   git push origin feature/my-feature-request

6. Open a pull request: Go to the original repository and create a PR with a clear description.

Support

If you need help or want to request a feature with Termix, visit the Issues page, log in, and press New Issue. Please be as detailed as possible in your issue, preferably written in English. You can also join the Discord server and visit the support channel, however, response times may be longer.