headscale icon indicating copy to clipboard operation
headscale copied to clipboard

Fix/improve documentation formatting

Open majabojarska opened this issue 2 years ago • 0 comments

Description

Fixes markdown formatting/indentation issues to properly render via mkdocs:

  • Enumeration. Several enumerated lists rendered improperly, as multiple "1." entries: image
  • Replace sequential enumeration (1. 2. 3. ...) with 1.-based enumeration. The renderer takes care of mapping the correct index to each list element. Generally easier to maintain.
  • Improves readability by using admonitions, e.g.: image
  • Improves consistency of monospace formatting for package/image names.

Validation steps

  1. Run make serve.
  2. Open the live preview.
  3. Inspect the rendered documents relevant to the PR's scope.

  • [x] read the CONTRIBUTING guidelines
  • [ ] ~raised a GitHub issue or discussed it on the projects chat beforehand~ Not applicable
  • [ ] ~added unit tests~ Not applicable
  • [ ] ~added integration tests~ Not applicable
  • [x] updated documentation if needed
  • [ ] updated CHANGELOG.md

majabojarska avatar Oct 15 '23 13:10 majabojarska