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

[RFC] Refactor documentation system #37

Open
Nek- opened this issue Aug 25, 2019 · 0 comments
Open

[RFC] Refactor documentation system #37

Nek- opened this issue Aug 25, 2019 · 0 comments
Labels
enhancement New feature or request
Milestone

Comments

@Nek-
Copy link
Contributor

Nek- commented Aug 25, 2019

The current documentation system is based on swagger-php, which is a pain. The automatic generation of the documentation is a real pain for the maintainers of Melodiia. Documentation extension process will be a pain for users...

That's why I suggest removing the automatic generation of documentation. Melodiia will just provide swagger integration (a controller that render swagger). This means adding a new configuration item for the documentation file (yaml). We're also gonna remove any documentation item from the configuration.

@Nek- Nek- added the enhancement New feature or request label Aug 25, 2019
@Nek- Nek- added this to the v1.0.0 milestone Aug 25, 2019
Nek- added a commit to Nek-/Melodiia that referenced this issue Nov 26, 2021
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

1 participant