integrate a docusarus to move the documentation to there

Surnet / swagger-jsdoc

Generates swagger/openapi specification based on jsDoc comments and YAML files.

MIT License

1.66k stars 224 forks source link

integrate a docusarus to move the documentation to there #318

Open daniloab opened 2 years ago

daniloab commented 2 years ago

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

stale[bot] commented 2 years ago

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.

rockingrohit9639 commented 1 year ago

hey, @daniloab Can I work on this issue?

daniloab commented 1 year ago

hey, @daniloab Can I work on this issue?

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

rockingrohit9639 commented 1 year ago

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?

daniloab commented 1 year ago

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

rockingrohit9639 commented 1 year ago

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