Document the Documentation

mastodon / documentation

Mastodon documentation

https://docs.joinmastodon.org

GNU Free Documentation License v1.3

1.7k stars 974 forks source link

Document the Documentation #796

Open e1mo opened 4 years ago

e1mo commented 4 years ago

I have found no documentation on the documentation. This includes: which static site generator is used (hugo) and how to contribute (setting up development environment etc.).

It would be great to have a bit of explanation within the README.md or somewhere else where it is obvious.

aaaaalbert commented 1 month ago

I think these suggestions are implemented in the meantime, see the following commits:

a149c0e: README mentions Hugo
ae82522: README mentions hugo serve (which, admittedly, is not everything one needs to know to set up a local test enviroment, but it's better to leave the setup etc. instructions to Hugo's own repo rather than a bespoke how-to for Mastodon Docs, IMHO)
325dc1f: README links to Mastodon's main CONTRIBUTING document