search

joffrey-bion / livedoc

A not-so-annotation-based documentation generator for REST and websocket services
MIT License
4 stars 2 forks source link

Add comprehensive documentation for Livedoc annotations #105

Open joffrey-bion opened 6 years ago

ST-DDT commented 6 years ago

I noticed that you added/changed issue templates to this repo. Maybe you should use your own issues as a good example of what you expect others to submit.

What are you planning to do/add here?

joffrey-bion commented 6 years ago

Haha good catch! 🥇 The 2 templates I added are for bug reports and feature requests, neither of which corresponds to writing new documentation (although incorrect doc could qualify as bug report).

The main goal of the templates is to help people know which kind of information is useful to fix the issue/develop the feature, and thus know what to write in the issue in order to help me or a potential contributor.

This issue merely acts as a simple reminder for myself, as I don't expect any contributor to spend his own time on the boring task of writing doc, I guess that's on me :) The content of this issue will evolve as I think about particular items that I need to remember to put in the doc, but I believe I won't need to elaborate much, since there is simply everything to write about how to use the annotations.