Enhance docs - Githubissues

nanoblox / core

https://nanoblox.github.io/core/

Mozilla Public License 2.0

56 stars 17 forks source link

Enhance docs #29

Closed 1ForeverHD closed 3 years ago

1ForeverHD commented 4 years ago

Implement features such as 'tags', 'types', etc , similar to evaera's Promise API (https://eryn.io/roblox-lua-promise/lib/) (https://raw.githubusercontent.com/evaera/roblox-lua-promise/061c3a8659d97360df0a001a7143506cf907e21d/lib/README.md), when writing documentation with mkdocs and material (https://squidfunk.github.io/mkdocs-material/),

1ForeverHD commented 4 years ago

This may be achievable with material 'metadata': https://squidfunk.github.io/mkdocs-material/extensions/metadata/

1ForeverHD commented 4 years ago

To do

[ ] expand upon the coded examples to show return values
[ ] remove test tags
[ ] redo tag colors
[ ] apply tags to everything
[ ] deploy docs

1ForeverHD commented 3 years ago

Explore an automated system like that from codekingdom where you can write the docs within the coded modules themselves: https://github.com/CodeKingdomsTeam/rodash/blob/dab7ffe5fb4a24723a7d288f0b20f63a628b3bc4/src/Tables.lua

MrAsync made one too, might be worth checking out: https://twitter.com/MrAsync/status/1314261969965379584