Welcome ¶

This documentation lives online at indevets.github.io/core/nAEIGGJzbW

Warning

GitHub Pages sites are always public, even for private repositories!

To provide a level of security, the GitHub Pages instance of this site is “hidden” under a top-level directory with a randomly-generated name. Treat the full URL as a secret, being logged into GitHub is not a requirement for accessing it.

Publishing documentation ¶

Just push to the develop branch and the GitHub Actions automation will update the online site within a couple minutes.

Writing documentation ¶

This documentation is generated with MkDocs. See the MkDocs documentation for detailed information on writing and styling documentation.

Live previews ¶

With Chef Habitat installed, you can serve a live-updating documentation site while you edit locally:

# launch studio container shell
script/studio

# set up and launch MkDocs server
docs-watch

File layout ¶

mkdocs.yml                  # the configuration file
docs/
    README.md               # the documentation homepage
    ...                     # other markdown pages, images and other files

.holo/branches/gh-pages/nAEIGGJzbW/
    _indevets-core_.toml    # configuration for extracting documentation
                              sources from repository

.holo/branches/gh-pages.lenses/
    mkdocs.toml             # configuration for building documentation into
                              gh-pages content

.github/workflows/
    docs.yml                # configuration for GitHub Actions to update
                              gh-pages branch on push to develop

Added features ¶

Several additional features/extensions are enabled in the documentation site: