Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate the documentation statically #93

Open
unixfox opened this issue Jun 25, 2021 · 2 comments
Open

Generate the documentation statically #93

unixfox opened this issue Jun 25, 2021 · 2 comments
Labels
enhancement New feature or request

Comments

@unixfox
Copy link
Member

unixfox commented Jun 25, 2021

We should use a static page generator instead of WikiJS for the documentation, it's much more stable and can be hosted on GitHub pages.

Candidates:

  • Jekyll
  • Hugo
  • MkDocs
  • Hexo
  • Something else?
@unixfox unixfox added the enhancement New feature or request label Jun 25, 2021
@syeopite
Copy link
Member

MkDocs

If we decide to use Mkdocs, it looks like the mkdocs-material theme is the standard for the Crystal ecosystem.

@SamantazFox
Copy link
Member

I'm posting here the message I wrote on matrix. The idea is to switch out from Markdown, because it's hardly standard an not suited for proper documentation. In all the options we have (RST, Dita, Docbook, AsciiDoc, (La)Tex), RST is the easiest to use and the most flexible.

roadmap for the docs, if you want to do it in a way that will be maintainable in the future, and flexible enough to be integrated into the website:

  1. move the instance list to the instances-api repo & make it a YAML list, so we can easily parse it and render it to anything (and also we won't have to maintain the static HTML list anymore in that repo)

  2. restructure the docs (folder structure) and convert it to RST at the same time

  3. configure sphinx, select/make a simple theme for the docs

  4. make the CI pipeline for auto build/deploy of docs

  5. update docs (rewrite most of it)

  6. add project to weblate, so we can have the docs in other languages, too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Ideas / Not decided
Development

No branches or pull requests

3 participants