microsoft / microsoft/qdk

Add API doc summaries for namespaces

Open
#1,823 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement language
Dominant language
Rust
Stars
1k
Forks
212
Avg merge
3d 8h
Merged PRs (30d)
65

Description

**Is your feature request related to a problem? Please describe.**
We used to have namespace summaries that included the tables of operations/functions/UDTs defined by that namespace and their one-sentence summaries (the first element of their API docs). https://learn.microsoft.com/en-us/qsharp/api/qsharp/microsoft.quantum.arrays is an example URL (redirects elsewhere now).

These were very useful for somebody trying to figure out whether a certain functionality exists within a library, for example, a certain array manipulation logic, but not knowing how exactly it is called. Now, one can only scroll the list of names, and to get the idea of what the operation does they need to go to the specific operation page. This is inconvenient.

**Describe the solution you'd like**
Return namespace summary doc pages.

Contributor guide

Open the contributing guide

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

No files or tests are named. Start by tracing how API documentation pages are generated and compare the current namespace pages with the linked Microsoft Quantum example. Done means namespace pages again include tables of operations, functions, and UDTs with their one-sentence API summaries.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.