Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Process for adding or removing pages in language docs is unclear #151

@bamarsha

Description

@bamarsha

To get the language docs to show up in the user guide at https://docs.microsoft.com/en-us/azure/quantum/user-guide/, there are stubs and a UID mapping defined for each page here: https://github.com/MicrosoftDocs/quantum-docs/tree/main/articles/user-guide/language

However, if pages are added or removed, the stubs don't seem to be updated automatically. It's not clear to me what the process is for updating them and it doesn't seem to be described in this repo. I think it would be better to:

  • Document clearly how this other repo is supposed to be updated so that people making changes to the Q# docs here will know what to do.
  • Update the CI to prevent merging PRs that add or remove pages without updating the corresponding stubs/UID map (like Document lambda expressions #136).

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationIssues related to the specs or documentation maintained on this repository

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions