Skip to main content

Documentation Developer Guide

Welcome to the Synthergy documentation developer guide! This page is designed to help you get started on contributing to the documentation component of the project.

Project Repository​

The documentation for Synthergy is hosted in the synthergy-docs repository on GitHub. This repository contains the Markdown files that are used to generate the project's documentation website.

To access the repository, you will need to join the synthergy-game organization on GitHub. Once you have been added to the organization, you will be able to clone the repository and start contributing.

Project Structure​

A large portion of the repository is the Docusaurus template, which is used to generate the documentation website. The Markdown files that make up the content of the website are located in the docs directory. Only these files should be modified when contributing to the documentation (unless you are making changes to the website template itself).

Running the Project​

If you would like to run the documentation website locally to see your changes in real-time, follow these steps:

  1. Clone the synthergy-docs repository.
  2. Install the project dependencies by running npm install in the project directory.
  3. Run the development server by running npm run start.

The website should now be running on http://localhost:3000! You can access the website in your browser to view the documentation and see your changes in real-time.

Resources​