SRCF / projects

A collection of projects that the SRCF is looking for help with
0 stars 0 forks source link

New way of doing docs #2

Closed matiasilva closed 3 years ago

matiasilva commented 3 years ago

Project/idea summary

Move to a technology like Hugo that allows us to generate content in markdown. Also, look into providing the option to download as a PDF or generate one page with all docs.

Requirements

Motivation

Myself and others in the team are not fans of Restructured Text and would much prefer it if content were in Markdown, this is pretty standard nowadays. Additionally, there seems to be issues with the search function and organization. This would be a good time to reorganize everything and make docs as easy to navigate as possible.

Alternatives considered

Could go with some existing knowledge base software, but why?...