GregTech-Experimental icon indicating copy to clipboard operation
GregTech-Experimental copied to clipboard

Published 20 hours ago • verified publisher icon Su5eD

Documentation Work

Open Su5eD opened this issue 2 years ago • 0 comments

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 avatar Aug 05 '21 21:08 Su5eD