feat: docgen

[cmilesdev]

Changes

• Added thorough comments and examples for all public API methods
• Adds ./docs/watcher.sh which will watch the codebase for changes and run our documentation code generators
• Adds ./docs/readme/main.go which will update the API index and write examples from function examples. Each function is annotated with a "@group" which categorizes it into an easy to consume human API index.
• Adds ./docs/examplegen/main.go which will compile all of the examples from comments into self contained, self runnable examples under ./examples/
• Adds example_compile_test.go which will run and compile all of the examples under ./examples ensuring that they all work and can compile

See readme preview https://github.com/goforj/godump/tree/cmilesdev/doc-gen?tab=readme-ov-file#api-index

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[cmilesdev]

@ccoVeille ready when you are