Versions Compared

Key

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

Table of Contents
absoluteUrltrue


What is this?

This page contains information related to the Nephio documentation. This is not  the documentation itself. The documentation lives in https://docs.nephio.org/

Documentation guide

Note! This is not a documentation guide, but a list of things related to the creation of one.

Things to decide

  • US or British English?
  • 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?
  • ToC or not ToC?
  • When we have links at the bottom of our pages?

Framework

Currently we use the Hugo/Docsy/Netlify framework to generate and host the documentation. This section collects the pros and cons of the different frameworks.