Wombat Docs

The documentation for 4788s wombat library.

Important

View the production version of the documentation here: https://4788-docs.vercel.app/

Contributing

If you would like to contribute to the documentation, please fork the repository and make a pull request into the master branch here: https://github.com/CurtinFRC/Wombat-Docs.git.

Running

To run the documentation locally, you will need pnpm (or equivalent) installed. Then run the following commands:

pnpm install
pnpm run dev

Building

To build the documentation, you will need pnpm (or equivalent) installed. Then run the following commands:

pnpm install
pnpm run build

The built documentation will be in the dist directory.

You can find the most updated code for wombat in our GitHub repository. Wombat will be located in the wombat directory of the repository.

Note

You can also find a less up to date version of wombat in a separate repository here