monero
monero copied to clipboard
monero-project
Utils: add manpages
Out of curiosity; the files say they were automatically generated by pandoc. What is the original info that was fed into pandoc to generate these?
Out of curiosity; the files say they were automatically generated by pandoc. What is the original info that was fed into pandoc to generate these?
https://github.com/MexicanTakeout/monero-man-pages-wip The markdown docs are originally from https://github.com/monerodocs/md/tree/master/docs/interacting I edited them to follow the man-pages convention.
Much as I like the intent, I'm not sure it's a wise idea to have links in official (which is what they'd become if merged to this repository), man pages link to unofficial, partially maintained, external documentation. At a glance, I noticed a few things in this offsite unofficial documentation that are not exactly correct or outdated.
Ideally we'd want to automate generation of man pages from the embedded documentation.
We could use getmonero.org as a source directly, it's just a matter of converting to man page format using pandoc, but then those won't follow manual page format convention like missing Description, Options, References sections. This is the reason why I modified the docs in a separate fork which was not automatically generated from these sources :((
The reason I chose the unofficial docs at monerodocs because they have more information and example usages compared to at getmonero.org. Also I see some contributors over there are Monero project people so it would be potentially safe to reference.