This repository represents the application which is used by developers and key stakeholders to document the Hungerrush Handheld platform. The documentation is written in Markdown and is rendered by Hugo. The documentation is hosted on GitHub Pages and is available at https://iiimpact.github.io/hungerrush_handheld_docs/.
Contributions are welcome. Please follow the setup and usage guides in this README to submit a pull request. a
- Install Hugo on your machine. See Hugo installation guide.
- Clone this repository to your machine.
- Run
hugo serverin the root of the repository to start the Hugo server. - Open http://localhost:1313/dhungerrush_handheld_docs/ in your browser to view the documentation.
- Make changes to the documentation via a code editor and refresh the browser to see the changes.
- When you are ready, submit a pull request in this repository.
- Once the pull request is merged, the documentation will be automatically updated on GitHub Pages.