Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Do we have an option to describe the output of commands inline or they are always in a code block?
  • Do we use the console code block of we use bash instead?
  • When we have links at the bottom of our pages?
  • When to have a "this page is draft note"?
  • Do we enable "TBD"s in the documentation?
  • Do we allow only K8s, both Kubernetes and K8s or only Kubernetes?
  • Common way for notes and alerts using the example from here: https://www.docsy.dev/docs/adding-content/shortcodes/#reuse-documentation ?
  • Do we allow inline links, [] kind of links and/or footnotes

Things decided

  • US English
  • Do not manually add ToC
  • Do not use H1 (#) headers
  • Start headings with H2 (##)

...