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

[EPIC] API docs redesign phase 2 #1808

Open
4 tasks
Eric-Arellano opened this issue Aug 8, 2024 · 0 comments
Open
4 tasks

[EPIC] API docs redesign phase 2 #1808

Eric-Arellano opened this issue Aug 8, 2024 · 0 comments
Labels
epic 🏔️ infra 🏗️

Comments

@Eric-Arellano
Copy link
Collaborator

We made huge improvements to API docs in #479. This epic is to track other follow-up improvements we still want to make.

Tasks
Preview Give feedback
  1. Move class attributes to a more relevant location #1098
    API docs infra 🏗️
  2. Historical API docs inlining: place methods in Methods section #1388
    API docs bug 🐛 infra 🏗️
  3. Move API headings inside the component #1395
    API docs infra 🏗️
  4. Always use a list for Params and Raises in API docs #1361
    API docs infra 🏗️
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
epic 🏔️ infra 🏗️
Projects
Docs Planning
Status: No status
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Eric-Arellano