GitHub Wiki Documentation

Welcome to the GitHub repository on documenting REST APIs for the GitHub wiki!

The example is for adding toppings to a pizza. This is similar to the traditional shopping cart but more flavorable.

There is nothing to build or run in this repository:
The wiki markdown is the source code.

You want to go to the wiki pages which is the purpose of this project: Home wiki page. For any GitHub project, it's in the GitHub top bar as "📖 Wiki" when enabled.

Trying it out

To properly clone this project you need to pick up the Git changes to the corresponding wiki pages, so clone like this:

$ git clone https://github.com/binkley/wiki-docs.git --recurse-submodules

(This is what essentially CI does.)

And update locally like this:

$ git pull --recurse-submodules

Without the --recurse-submodules option, you will either work with (potentially) outdated wiki files or manually update the wiki/ project directory directly or indirectly.

Extras

This repository includes the wiki-to-pdf.sh script and matching action workflow in CI. It generates a single merged PDF file for your wiki repository that goes with your code repository.

To see an example PDF:

1. Navigate to the Actions tab for this project.
2. Navigate into the latest green workflow run.
3. At bottom is an "Artifacts" section and the "wiki-docs" artifact is a ZIP of the PDF generated for the run.

(There does not seem to be a nice way for this README to make a direct link into the latest workflow run and point to the ZIP or PDF. All artifacts are always in a compressed file to help GitHub conserve storage and bandwidth.)