documentation icon indicating copy to clipboard operation
documentation copied to clipboard

[ NEW PAGE ] Documenting your ecosystem project

Open frankharkins opened this issue 1 year ago • 2 comments

Advice for new projects on setting up high-quality documentation. It should cover:

  • Setting up Sphinx (maybe also something simpler?)
  • Documentation best practices
  • qiskit-sphinx-theme

We can base this on https://qisk.it/docs-guide

### Tasks

frankharkins avatar Jul 15 '24 12:07 frankharkins

Also - @beckykd @abbycross -- help write tips -- couple pphs -- for non-writers doing documentation

abbycross avatar Jul 25 '24 14:07 abbycross

Also - @beckykd @abbycross -- help write tips -- couple pphs -- for non-writers doing documentation

We could at the very least point to https://github.com/Qiskit/documentation/blob/main/style-guide.md

abbycross avatar Oct 08 '24 15:10 abbycross

The open source section is being inlined into the guides section, so there's no longer a natural place for this.

Eric-Arellano avatar Oct 23 '25 19:10 Eric-Arellano