Revamp docs navigation into subsites - #5532
Draft
kaelynj wants to merge 7 commits into
Draft
Conversation
Reorganize the flat guides directory into additional-resources, applications-research-tools, ibm-quantum-compute, ibm-quantum-platform, and qiskit sections, each with its own subsite and landing page, to improve navigability. Change wording of "initialize account" to "authenticate account"
The "Set up your IBM Cloud account" pages were separated by users with an invitation and those without. These pages are now combined and an admonition included to make navigation easier.
Move Qiskit Serverless docs from the IBM Quantum Compute service into Applications & research tools, and regroup Qiskit Functions there by domain (optimization, machine learning, differential equations, Hamiltonian simulation) instead of the old circuit/application split. Add a "Browse by domain" section with cards to the functions index page, and update the guides, api/functions, and ibm-quantum-compute tocs to match.
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Splits the flat docs/guides directory into five separate subsites, each with its own nav tree and (mostly) its own landing page:
qiskit,ibm-quantum-platform,ibm-quantum-compute,applications-research-tools, andadditional-resources. docs/guides is retained as the top-level entry point, now holding the main left-nav that links out to each subsite. In the hopes of improving the discoverability/navigability of the documentation.A few changes I also made along the way besides moving pages around
cloud-setup.mdx/cloud-setup-invited.mdx) into a single page, using an admonition to route invited vs. non-invited users instead of two separate pages.applications-research-tools, alongside Functions.