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.

Sign up for GitHub

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

Jump to bottom

Documentation #2

Open
Cayan opened this issue Nov 8, 2016 · 2 comments
Open

Documentation #2

Cayan opened this issue Nov 8, 2016 · 2 comments

Comments

@Cayan
Copy link
Contributor

Cayan commented Nov 8, 2016

Should we add a requirement for any type of documentation generator tool?
Are we going to enforce an specific API documentation pattern (like Swagger)?
@igorsantos07
Copy link
Contributor

This sounds like a hard requirement to be made, as some frameworks may provide this out of the box and some others don't - scaring those lighter guys out of the project.

This could be an optional requirement, such as HEAD/OPTIONS are.

@Cayan
Copy link
Contributor Author

Cayan commented Nov 8, 2016

I agree this should be optional, this is an extra feature and would be most useful if a repository serves as an skeleton project.

The idea behind this issue is just to discuss an API documentation format and if it should be automated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@igorsantos07 @Cayan