memos
memos copied to clipboard
usememos
Show the docs some love
Is your feature request related to a problem?
It's frustrating to get into developing on memos. The docs are barely existent, outdated, and there's no real documentation anywhere apart from trying to understand the code. I believe you could have a lot more contributors if you had a proper documentation.
Describe the solution you'd like
Update and create a proper documentation so that developing memos is straightforward and less frustrating. If I have some time, I'll start working on that, but I'd appreciate any help because I am still lost myself.
Additional context
No response
Could you show me what you think is a good development document? Or what specific problems you have encountered?
Good docs, for example, will give you a very graceful introduction onto how the app works. For example, the gonic/gin framework has fairly good documentation. You can click onto anything and it gives you a nice quick overview of how the systems work together.
Another great example for how to document the API would be the Lichess API Docs. They step you through how exactly the server expects payloads, what's required, what isn't, what the expected flow is etc. Other good examples include the Discord API and the Twitch API.
If you want to go extra fancy, have a look at how the HashiCorp Stack is documented. It gives you a step-by-step guide on how to get started modifying stuff, how to develop plugins for their services, how to integrate it etc.
As a final word, I believe it would already be more than enough if we properly documented how functions worked, added some comments (such as for example for server#Store.findUser/2: findUser/2 tries to find the referenced user using the provided information. Returns (*api.User, err).
For example, something that isn't documented right now that would be useful are instructions on how to build the web frontend for debug use. I've made a few changes and would like to test them before pushing, and that's a bit hard without frontend :,)