search

exlo89 / laravel-sevdesk-api

Helpfull Laravel package to work with the Sevdesk API.
MIT License
7 stars 12 forks source link

Documentation #6

Closed Sebbito closed 1 year ago

Sebbito commented 1 year ago

Right now it's not really clear what parts of the API are covered and which ones aren't. The Readme is a good start but perhaps there should be something more complete. Maybe there are some tools to automatically generate docs?

exlo89 commented 1 year ago

Currently, I add what I also program. But in a long time, you are right to generate all the docs. Did you have some recommendations on how to do that?

Sebbito commented 1 year ago

Nope I don't know about any automatic solutions. Maybe I'll find something.

Sebbito commented 1 year ago

I found phpdoc But as far as i can see it, that only automatically generates documentation in the form of html sites. Seems a little impractical.

Sebbito commented 1 year ago

Perhaps the Wiki Tab here on Github is good enough? Put the very basics into the README and the more fine-grained information into dedicated wiki pages.