Documentation and API - Githubissues

G-Node / gin-proc

BSD 3-Clause "New" or "Revised" License

0 stars 7 forks source link

Documentation and API #44

Closed achilleas-k closed 5 years ago

achilleas-k commented 5 years ago

User documentation

We need user documentation that explains how users should interact with the gin-proc interface, what it does, and what they can expect.

API and internals

Developer/maintainer documentation that explains the program flow, API endpoints for gin-proc backend and how front-end, back-end, and GIN/GOGS interact at each step.

achilleas-k commented 5 years ago

Clean up README and move sections to different documents:

Keep Introduction, Authors and Contributors, and Lincense info in the README.
Move FAQ to its own document (docs/faq.md).
Move Installation section to new document (docs/installation.md, or setup.md, or similar).
Move usage to its own document as well.