GTNewHorizons / GT-New-Horizons-Modpack

New Modpack with Gregtech, Thaumcraft and Witchery
https://www.gtnewhorizons.com/
Other
948 stars 296 forks source link

Make code files or specific files compatible for wiki fetching so wiki is up to date with changes. #13958

Closed FindMeSomeFun closed 11 months ago

FindMeSomeFun commented 1 year ago

Your GTNH Discord Username

FindMeSomeFun

Your Pack Version

2.3.0

Your Proposal

We should make wiki page for every machine with a relevant info that is accessed directly from code files or specific files auto generate on every release.

Your Goal

In that way wiki pages would be up to date without a need for manual change.

Your Vision

Every machine's page should have a description of machine's purpose and intended functionality that should be written by programmer in class description or in some other way so wiki visitors could read programmers vision and programmed way of functioning. After description there should be a table with all relevant info about that machine like: min/max size, building blocks order from code, later machines preview, is it rotatable, pollution, bonuses, real bonuses formula from code that would be used with some default example result and all relevant useful info. Also, that table should have columns with recommended version data, maybe also minor recommended version data and latest version data so wiki visitor can see changes that are happening or will happen on update. This table would also be useful for bugs/errors in case some unintended changes like missing single zero in durability or wrong multiplier in latest version. Generally visitors would have all relevant data to skim through. After that table we should have calculator relevant for that machine, and finally tutorial or detailed explanation related for that machine. In this way we would have all data in a single place readily available without need for visiting ten different places to piece it all together.

I am willing to help with this but I need cooperation. As a proof of concept I have made https://github.com/FindMeSomeFun/gtnh-questbook-wiki which is simple, low level code, easily changable single page website.

Final Checklist

github-actions[bot] commented 11 months ago

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 3 days