Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #16

Open
docteuri opened this issue Aug 30, 2018 · 1 comment
Open

Documentation #16

docteuri opened this issue Aug 30, 2018 · 1 comment
Labels
enhancement New feature or request

Comments

@docteuri
Copy link

Hello,

I would like to help on the auto-documentation part.

Do you have in mind a composer class you would prefer to use ?

It could be phalcon-swagger or swagger-php for API
and ApiGen for docs.

Thanks a lot for this lib

@niden niden added the enhancement New feature or request label Aug 31, 2018
@niden
Copy link
Member

niden commented Sep 1, 2018

Hello @docteuri

For the documentation, since this is an example application and has limited endpoints I was planning on creating markdown files explaining each endpoint in detail and then showing it on screen using a volt file/view.

I will give Swagger a try to see if it can help us.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants