Docs TODO

[kolaente]

I think we all agree the docs need improvement, mostly on the "under the hood" side of things, aka docs for developers.
This issue is meant an extending list of things we need to add/improve in the docs. Feel free to comment new points, I'll update it.

These are things I thought of, by no means complete.

• General structure
• Makefile
• Adding new migrations
• Adding new config options
• Integration tests
• Where to add new endpoints (not sure about this one)
• Custom errors
• Swagger docs

cc @jonasfranz

[mmarif4u]

As this issue is about docs, so let me ask my question here. :)

@jonasfranz in the doc for OAuth2, i guess how to use refresh token is missing?
https://docs.gitea.io/en-us/oauth2-provider/

I have few other questions regarding OAuth2, but maybe next time in PM or GitNex issue.

Thanks for your work on this.

[jonasfranz]

@mmarif4u Yes, refresh tokens are not documented yet. But they're documented at the linked spec. I will add the refresh token part later.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs during the next 2 weeks. Thank you for your contributions.

[6543]

make has help target do document itslef