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 content improvements #1892

Open
2 of 5 tasks
Eric-Arellano opened this issue Aug 30, 2024 · 0 comments
Open
2 of 5 tasks

[EPIC] API docs content improvements #1892

Eric-Arellano opened this issue Aug 30, 2024 · 0 comments
Labels
API docs content 📄 epic 🏔️ infra 🏗️

Comments

@Eric-Arellano
Copy link
Collaborator

Eric-Arellano commented Aug 30, 2024 •
edited by javabster
Loading

This is focused on improving the content itself, unlike #1808 being focused on the visual design / web app.

Infra tasks
Preview Give feedback
  1. Spellcheck API docs #818
    infra 🏗️ needs discussion 💬
  2. Check links for API docs (Qiskit 0.46+) #495
    API docs epic 🏔️ infra 🏗️
    Eric-Arellano
  3. Add doc testing to Python client repositories #1893
    API docs infra 🏗️ needs discussion 💬
    frankharkins

Content tasks
Preview Give feedback
  1. Deduplicate visualization guide with API references? #172
    content 📄 needs discussion 💬
    abbycross beckykd
    javabster
  2. add code examples to all API ref pages #1894
    API docs content 📄 on hold ⏸️
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
API docs content 📄 epic 🏔️ infra 🏗️
Projects
Docs Planning
Status: No status
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Eric-Arellano