Skip to content

Documentation Work  #30

@Su5eD

Description

@Su5eD

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentation📖Improvements or additions to documentationhelp wanted🤝Extra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions