Dedicated place for documentation to live

WarFrontIO / client

Real-time strategy game played in the browser

https://dev.warfront.io

MIT License

20 stars 6 forks source link

Dedicated place for documentation to live #7

Closed theotherhades closed 3 months ago

theotherhades commented 3 months ago

Currently documentation kinda just lives in JSDoc comments and some markdown files inside the source code itself (MODULES.md, HUD.md for example). It might be a good idea to move documentation to a dedicated site (docs.warfront.io?), GitHub wiki, or something of the like, rather than directly in the source code.

platz1de commented 3 months ago

This isn't a library, contributing requires looking in the source code anyways. Moving docs somewhere else only complicates things by requiring a search to find the appropriate information Mod support (which would benefit from packagedocs) is too far into the future to justify the effort now.