Skip to content
This repository has been archived by the owner on Nov 16, 2024. It is now read-only.

webgptorg/webgpt-docs

Repository files navigation

Contributing

###TODO: review

To contribute to the documentation, you need to have Hugo installed. Follow these steps to install Hugo:

  1. Download the latest version of Hugo from the official releases page.
  2. Follow the installation instructions for your operating system here.

After cloning the repository, you can make changes to the documentation. To preview your changes, run the following command from the root directory of the repository:

$ hugo server

When done, you build the site by running the following command:

$ hugo --minify

and (typically all changes are made in the public directory) you add the changes to the staging area and commit them with a meaningful message:

$ git add .
$ git commit -m "Your message here"

Finally, you push your changes to the gh-pages branch using the subtree command to push just the public directory where the Hugo site is built:

$ git subtree push --prefix public origin gh-pages