swagger-jsdoc icon indicating copy to clipboard operation
swagger-jsdoc copied to clipboard

integrate a docusarus to move the documentation to there

Open daniloab opened this issue 2 years ago • 6 comments

the main idea is to move the markdown documentation to a docusaurus page and make it easier to read these same docs, to add new ones, find it by adding a search bar and more improvements.

  • [ ] add a docusaurus page
  • [ ] move the docs to there
  • [ ] has each docs by each existent docs from each version

daniloab avatar Apr 18 '22 14:04 daniloab

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Jun 17 '22 20:06 stale[bot]

hey, @daniloab Can I work on this issue?

rockingrohit9639 avatar Jul 30 '22 16:07 rockingrohit9639

hey, @daniloab Can I work on this issue?

Sure @rockingrohit9639 feel free to work on it and I will help you with reviews

daniloab avatar Aug 01 '22 17:08 daniloab

hey, @daniloab Can I work on this issue?

Sure @rockingrohit9639 feel free to work on it and I will help you with reviews

Thank you for allowing me to work on this project. Can you please tell me where should I start, there is already a directory called docs in the root folder then what should I name docusaurus directory?

rockingrohit9639 avatar Aug 02 '22 03:08 rockingrohit9639

hey, @daniloab Can I work on this issue?

Sure @rockingrohit9639 feel free to work on it and I will help you with reviews

Thank you for allowing me to work on this project. Can you please tell me where should I start, there is already a directory called docs in the root folder then what should I name docusaurus directory?

Yes, in your pr I will just cleanup the docusaurus default content

daniloab avatar Aug 02 '22 12:08 daniloab

Hey @daniloab Please tell me if there is anything required in the documentation.

rockingrohit9639 avatar Aug 09 '22 10:08 rockingrohit9639