ModdingDocs
ModdingDocs copied to clipboard
R2Northstar
RFC: Restructuring the structure
I'm generally unhappy with the structure of the docs, especially the guides feel quite unordered and cluttered.
My current thoughts are to group them thematically, in sections like "making mods", "clientside mods", "serverside mods".
i also want the meta-documentation moved to it's own section (restructuredtext cheatsheet, how to contribute) and possibly expanded into docs on contributing to Northstar.
Agreed sidebar could use some cleanup ^^ In particular something that would also be nice, would be collapsing sections by default, so that on a standard 1080p screen, all main sections are visible on the sidebar without scrolling and then organising things in a proper tree view.
As for how to organise the sections, we have
- Quickstart guides
- Squirrel related
- Skins/Repak
- Mapping (related to skins but not quite, very WIP)
- Native/C++ and in the future plugins
where the native C++ part is a bit of an odd one out as it is less modding and more development related.
I think something like the above listing could work for the main sections.
Where applicable some guides could also be moved to their respective category but some should stay top-level (like how to upload to Thunderstore) simply cause they encompass multiple of the main headings.
It might be worth separating "guides" and "docs" IE, how to use a specific function or feature vs how to create a mod from scratch with.
with the closing of
- #134
i consider this mostly done. feel free to still PR individual adjustments to the structure
Closing as completed with #134
A future restructure should be done on the new docs located at https://github.com/R2Northstar/NorthstarDocs anyway ^^