Qiskit / Qiskit/documentation

Standardize beta feature labeling

Open
#4,022 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content 📄 needs discussion 💬 on hold ⏸️
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

URL to the relevant guide or resource

https://quantum.cloud.ibm.com/docs/en/guides/fractional-gates
https://quantum.cloud.ibm.com/docs/en/guides/stretch

Select all that apply
  • new content request
  • typo
  • code bug
  • out-of-date content
  • broken link
  • other
Describe the fix or the content request.

As our services are becoming GA compliant, we should have a clear and consistent way of labeling beta features. For example, both fractional gates and stretch pages use experimental, and that mention is embedded in a paragraph and can easily be missed.

For new content requests - if the request is accepted, do you want to write the content?

I only want to review the material when it's finished

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the fractional gates and stretch guides at the two URLs, focusing on how each currently labels experimental features. First identify a consistent labeling approach for beta features, then update the relevant documentation and verify that both pages present the status clearly and consistently.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.