No "Code documentation" section/chapter

[EpicEric]

Currently, all information there is on creating code documentation is hidden in appendices/whitespace.md, and only mentions how to add docstrings.

This should either be a new section in "Appendices", or an entirely new chapter, as it makes it easier to use and contribute to Pony libraries. Some information I'd expect to find:

• Adding docstrings to Pony code
• Generating Markdown from Pony sources
• Generating Mkdocs from Markdown
  • And how to use the official Mkdocs theme
• Deploying to main.actor

[EpicEric]

Updated to reflect the addition of main.actor

[SeanTAllen]

@EpicEric would you be up for taking this on?

[EpicEric]

As I see it, documentation generation is not stable for non-stdlib use as of right now (ponylang/ponyc#2774), and the (partial) solution to that through main.actor is also not done, so I'd hold out on this part of the issue.

What can be done as a starting point for now is refactoring out the docstrings part from the Whitespace section, possibly as a new Appendix section for the time, thus improving its visibility.

[SeanTAllen]

Sounds reasonable @EpicEric

[rhagenson]

For anyone tackling this as their first issue, feel free to move the Whitespace section into an Appendix (as Eric suggests). If you are feeling extra helpful, expanding that new "documentation" appendix to include steps on building documentation locally might be a nice addition.

[rhagenson]

There are documentation-related matters in the Appendix here.