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

API reference uplift #5665

Open
4 of 17 tasks
jstirnaman opened this issue Nov 5, 2024 · 0 comments · May be fixed by #5595
Open
4 of 17 tasks

API reference uplift #5665

jstirnaman opened this issue Nov 5, 2024 · 0 comments · May be fixed by #5595
Milestone
API reference uplift

Comments

@jstirnaman
Copy link
Contributor

jstirnaman commented Nov 5, 2024 •
edited
Loading

Improve API reference docs for UX and performance.
Replace ReDoc

To do:

  • Generate Hugo pages for endpoints and OpenAPI operations in the spec.
  • Use Rapidoc to render generated spec pages
  • Implement theme switching.
  • Set API server to the user's configured docs site URL.
  • Show page title
  • Use tag name as nav link
  • Use tag name as page title
  • Expand/collapse API servers section
  • Use only one tag per path--provides a title-name and description for the path
  • Add Using the <name> API page with traitTag content
  • Remove traitTags from paths
  • Move related links from description body to related frontmatter
    • Replace or ReDoc endpoint tag references with new URLs
    • Replace or alias outdated and broken site links.
  • Fix nested scrollbar
  • Fix styles
  • Fix index page descriptions (use Rapidoc mini or docs-native endpoint shortcode)
@jstirnaman jstirnaman linked a pull request Nov 5, 2024 that will close this issue
chore(api-ref): Uplift API reference docs: #5595
Draft
@jstirnaman jstirnaman added this to the API reference uplift milestone Dec 6, 2024
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
API reference uplift
Development

Successfully merging a pull request may close this issue.

chore(api-ref): Uplift API reference docs: influxdata/docs-v2
1 participant
@jstirnaman