You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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):
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.
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):
Where:
There is a lot of content to review, so I'm gonna split this task in smaller ones
The text was updated successfully, but these errors were encountered: