search

Melkeydev / go-blueprint

Go-blueprint allows users to spin up a quick Go project using a popular framework
https://docs.go-blueprint.dev/
MIT License
5.89k stars 333 forks source link

📋 Project Documentation 📋 #165

Closed Ujstor closed 8 months ago

Ujstor commented 11 months ago

Tell us about your feature request

Go-blueprint is expanding and comprehensive documentation covering its features, technical aspects and examples within projects where the blueprint is used would be highly beneficial.

You can enhance the existing MkDocs template with more concise content and better organize its structure. We are also open to other implementations if you find them easier to maintain and more aesthetically pleasing.

In the future, we anticipate the introduction of more features that might not be inherently obvious in their usage. A good example is DB Migration and Cobra as a control mechanism, as discussed in #157. Although it is still in the early stages, documentation will be essential once implemented.

The discussion in #153 is also relevant.

Every contribution is invaluable, so feel free to add your part to this project.

Disclaimer

Melkeydev commented 10 months ago

I am going to be looking into this more - sorry for the massive delay