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

Docs Guidelines: clarify qiskit vs beyond qiskit strategy #149

Closed
javabster opened this issue Dec 13, 2022 · 2 comments
Closed

Docs Guidelines: clarify qiskit vs beyond qiskit strategy #149

javabster opened this issue Dec 13, 2022 · 2 comments

Comments

@javabster
Copy link
Collaborator

We should organise some discussion around the strategy for documentation in terms of a strategy for Qiskit Terra docs and non-qiksit-terra docs.

We should cover the following questions in our discussions:

  • Is the chimera project only covering Qiskit Terra? Or should we also plan to integrate applications modules etc into qiskit.org?
  • What are the branding requirements for docs for different qiskit adjacent packages?
  • What are the long term plans for the sphinx theme? Should we still maintain the sphinx theme for use by the broader qiskit ecosystem? Who should maintain the theme?
  • What parts of documentation should we be actively involved in maintaining, and which should we just provide guidelines for? e.g. terra tutorials - do we actively maintain or just advise?

Definition of Done:

  • A page in the docs guidelines and internal open source wiki that explains the strategy and addresses the above questions
@javabster
Copy link
Collaborator Author

Expanding this issue to discuss the following:

  • what should the sphinx theme look like for ecosystem members - is there different branding? should we have ecosystem/tier criteria for who can use the qiskit sphinx theme and branding?
  • should we have a different top menu for qiskit.org and ecosystem projects?

@Eric-Arellano Eric-Arellano self-assigned this Feb 15, 2023
@Eric-Arellano
Copy link
Collaborator

This has had some progress. We now have the technology for different Sphinx "theme variants": #229

What remains is figuring out how exactly the ecosystem theme should be different, which is tracked by #311.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Done
Development

No branches or pull requests

5 participants