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

Documentation Work #30

Open
Su5eD opened this issue Aug 5, 2021 · 0 comments
Open

Documentation Work #30

Su5eD opened this issue Aug 5, 2021 · 0 comments
Labels
documentation📖 Improvements or additions to documentation help wanted🤝 Extra attention is needed

Comments

@Su5eD
Copy link
Owner

Su5eD commented Aug 5, 2021

Documentation

Software

After comparing several wiki's and static site generators, I have chosen to use Docusaurus for documentation.
Another candidate was BookStack, but as it turns out (issue 569), they don't plan to implement content localization anytime soon, which implies the same position regarding multi-version support. And those are critical features which I need.

Content

A list of things to document, sorted by priority:

  • Machines

  • Recipe/Fuel Config System

    • Recipe Providers
  • API

    • Structure format
  • Use of GT Books as part of the documentation.

  • Reuse (and improve) GT Community wiki content?

Repository link: https://github.com/Su5eD/GTE-Docs
I'll keep the issue here for now, in case I decide to merge the docs into this repo.

@Su5eD Su5eD added enhancement New feature/request documentation📖 Improvements or additions to documentation help wanted🤝 Extra attention is needed and removed enhancement New feature/request labels Aug 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation📖 Improvements or additions to documentation help wanted🤝 Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant