Following are just some general thoughts on documentation questions for fpm packages in general, but specifically for the registry; which is escalating the need for some consensus on how fpm packages need to be documented, at least at the level of an abstract.
The main question is what are the rules required by the README.md file on the registry; and since a lot of packages already contain a README file or equavalent should another name be used first that is specifically for the registry, or should the package checkin let you indicate a filename to display directly from the registry?
So far Fortran and fpm have not specified a documentation format or
tools to view it. Usually a README.md and a doc/ or docs/ directory
exists in fpm(1) packages; but the form and contents are dictated more
by what is supported by the home site of the package (github, gitlab,
…) if it has one.
Some of the most common tools for automatically generating documentation
for Fortran fpm(1) packages have been tending towards ford(1) and doxygen(1)
package output.
So what the registry will support as documentation is unclear to me.
If the README.md file will be displayed, which Markdown flavor wil
be supported? It is assumed to be a single self-contained file or will
graphics and URL links be supported?
Once a package is released on the registry by design it is nearly
immutable. So having some ability to preview a file is important to
ensure it is presentable before committing a package to the registry.
If a particular format is required, a list of resources for converting
to it such as pandoc(1) would be useful.
It would be great to support sophisticated documentation but outside of
pixel maps it is very hard to define a long-term format without issues.
LaTex, Adobe PDF, HTML5 + CSS, … everything has pros and cons.
A quick glance at other repositories and languages does not produce an
obvious answer.
Does anyone have suggestions and/or experience with on-line repostitory
documenation and local mirrored or cached documenation?
Does anyone have a Fortran-based md viewer?
Fortran is way overdue in supporting extractable free-format blocks of
comments and character array definitions as well; which would greatly
simplify maintaining basic documentation with the code itself, as most
languages do.