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.

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

Content audit for qiskit documentation #226

Closed
1 of 10 tasks
y4izus opened this issue Feb 15, 2022 · 1 comment
Closed
1 of 10 tasks

Content audit for qiskit documentation #226

y4izus opened this issue Feb 15, 2022 · 1 comment

Comments

@y4izus
Copy link
Collaborator

y4izus commented Feb 15, 2022

Content on documentation comes from different repos and in different ways, so we need to know where those files live:

In addition, the idea is to organize the documentation following the structure proposed by divio. Right now we have 3 types of documentation: API References, getting started files and tutorials. First one is attached to the code but the second and third ones are on different folders. We would like to know if those tutorials and getting started files fits the tutorials definition given on divio or if they belongs to any of the other categories: API References, how-to guides or explanations.

A proposal is to come up with a summary with this structure (I've added an example):

Project Tutorial Source File Doc type
Qiskit Nature Electronic Structure Link on qiskit-nature repo Tutorial

Where:

  • Project can be:
    • Qiskit core
    • Qiskit machine learning
    • Qiskit nature
    • Qiskit finance
    • Qiskit optimization
    • Qiskit experiments
    • Qiskit dynamics
    • Qiskit metal
    • Qiskit partners
  • Tutorial is the name of the tutorial and point to the page under qiskit.org/documentation. If the tutorial is under a category, you can add it too
  • Source file is the name to the repo where the tutorial lives and point to its code file
  • Doc Type can be:
    • API Reference
    • Tutorial
    • How-to guide
    • Explanation

There is a lot of content to review, so I'm gonna split this task in smaller ones

@1ucian0
Copy link
Member

1ucian0 commented Mar 21, 2023

I moved these issue to qiskit/qiskit_sphinx_theme as this content audit might be something under the Doc Guide. This should have a lower priority that the initial one. Once this epic gets ready to be worked on, let's reopen/create the task issues.

@javabster javabster closed this as not planned Won't fix, can't repro, duplicate, stale Jul 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done
Development

No branches or pull requests

3 participants