Skip to content

Documentation Strategy

andychu edited this page Jun 20, 2019 · 8 revisions

TODO:

  • Document our strategy for writing good docs!
  • Maybe: look at how Python / PHP, etc. do it. People seem to really like PHP docs, which help them with a confusing language.

Inputs

  • Human-written text
  • builtin signatures from osh/builtin.py, etc.
  • ? ... Test cases ... ?

Outputs

  • help builtin (following bash)

  • HTML for the website

  • man page (mdoc) @msingle is working on this.

  • Docstrings and flag description can be displayed in completion as well!

Clone this wiki locally