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

Add documentation to website #43

Closed
1 of 13 tasks
rohit-gohri opened this issue May 14, 2021 · 0 comments · Fixed by #87
Closed
1 of 13 tasks

Add documentation to website #43

rohit-gohri opened this issue May 14, 2021 · 0 comments · Fixed by #87
Labels
documentation Improvements or additions to documentation help wanted PRs are encouraged and will be accepted
Milestone
v0.5

Comments

@rohit-gohri
Copy link
Owner

rohit-gohri commented May 14, 2021 •
edited

The current website https://rohit-gohri.github.io/redocusaurus/ only has some examples. Add detailed documentation there and version it.

Current examples website leads a lot to be desired.

  • Add a separate docs section and move examples to a sub-path

Then add these docs:

  • Installation instructions
  • Add api spec
    • Customize doc path
  • Theming
    • Primary Color
    • Other Redoc Theme Options
  • Overriding Redoc Options
    • Download button
      • Custom url for download
  • Advanced Guides
    • Server Side Rendering
    • Importing into MDX
@rohit-gohri rohit-gohri added documentation Improvements or additions to documentation help wanted PRs are encouraged and will be accepted labels May 14, 2021
@rohit-gohri rohit-gohri mentioned this issue Aug 28, 2021
Closed
13 tasks
@rohit-gohri rohit-gohri added this to the v0.5 milestone Aug 28, 2021
@rohit-gohri rohit-gohri mentioned this issue Aug 28, 2021
Merged
This was referenced Sep 10, 2021
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted PRs are encouraged and will be accepted
Projects
None yet
Milestone
v0.5
Development

Successfully merging a pull request may close this issue.

v0.5 rohit-gohri/redocusaurus
1 participant
@rohit-gohri