Documentation

Improving our documentation skills. Keys are our word skills, understanding intended readers, and purpose and context of code comments, external documentation, automated tests, git commit messages, pull request descriptions, automated documentation, and error messages. And an exercise in using docsify.

Deployment: https://tymyrddin.github.io/documentation

Built with MkDocs using a theme provided by Read the Docs.

Installing mkdocs with pip, pipenv or poetry (example here is pip)

$ pip install mkdocs

Or by using the requirements file in the repo:

$ pip install -r requirements.txt

Launching the site in a local web server, running on port 8000 (in the directory where mkdocs.yml resides):

$ mkdocs serve

Using the built-in support for generating a static website by run the build command:

$ mkdocs build

This will generate an entire website in a new folder named site.

Deployment:

$ mkdocs gh-deploy