Open
Description
The goal would be to provide a centralized location that allows mod authors to publicly document the APIs of their mods. This would be most useful for mods that act primarily as a library to be used by other mods. Examples include: Crafting Framework, Skills Module, herbert lib, and so on.
Proposed structure:
- All modding APIs would be stored under a "Lua Modding APIs" section under the "Guides" section of the sidebar.
- Mod authors would be responsible for creating their own API pages, and this would be done by submitting a PR to this repo.
Additional suggestions:
- There may be benefit in writing a documentation-generator (similar to what MWSE currently uses, but preferably one not written in Lua, that parses regular text files) that would allow mod authors to use a special syntax to write the documentation for their APIs. This would allow LuaCATS type-hinting information to be automatically generated along-side the text added to the wiki page.
- This is probably overkill (for now anways), but it would be a fun programming project that I'd like to make at some point.
- There may be benefit in creating a secondary "Style Guide" specifically for documenting the use of Lua Modding APIs. Possibly one that encourages following RFC 2119.
Feel free to leave thoughts and suggestions on how to approach this topic. I'll leave this issue up for a couple days before I start to work on it, so there's time to take into account any suggestions people have.