Fix broken documentation links (#584)
* fix links * revert unwanted changes
This commit is contained in:
Родитель
54fabb3ed6
Коммит
e59c857bfa
|
@ -3,7 +3,7 @@
|
|||
Welcome, and thank you for your interest in contributing to Q#!
|
||||
|
||||
There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.
|
||||
For more details on how to contribute to Q# or the rest of the Quantum Development Kit, please see the [contribution guide](https://docs.microsoft.com/quantum/contributing/).
|
||||
For more details on how to contribute to Q# or the rest of the Quantum Development Kit, please see the [contribution guide](https://docs.microsoft.com/azure/quantum/contributing-overview).
|
||||
|
||||
## Asking Questions
|
||||
|
||||
|
@ -18,7 +18,7 @@ Have a feature request?
|
|||
We want to hear about it!
|
||||
Here's how you can make reporting your issue as effective as possible.
|
||||
|
||||
The Quantum Development Kit is distributed across multiple repositories. Filing an issue against the correct repository will help address it swiftly. Check the list [in the contribution guide](https://docs.microsoft.com/quantum/contributing/#where-do-contributions-go) to figure out which repo is a good place to file it.
|
||||
The Quantum Development Kit is distributed across multiple repositories. Filing an issue against the correct repository will help address it swiftly. Check the list [in the contribution guide](https://docs.microsoft.com/azure/quantum/contributing-overview#where-do-contributions-go) to figure out which repo is a good place to file it.
|
||||
You can follow the [template](https://github.com/microsoft/qsharp-runtime/issues/new?assignees=&labels=bug&template=bug_report.md&title=) for reporting issues on this repository.
|
||||
|
||||
|
||||
|
@ -43,7 +43,7 @@ please file one following the [feature request template](https://github.com/micr
|
|||
We will respond to feature requests and follow up with a discussion around its feasibility,
|
||||
how one might go about implementing it, and whether that is something we would consider adding to our repo.
|
||||
There are several reasons why we might not be able to eventually merge even a great feature for one reason or another.
|
||||
Take a look at our general contribution guide for [reasons why this might be the case](https://docs.microsoft.com/quantum/contributing/code#when-well-reject-a-pull-request).
|
||||
Take a look at our general contribution guide for [reasons why this might be the case](https://docs.microsoft.com/azure/quantum/contributing-code#when-well-reject-a-pull-request).
|
||||
Even if we are not able to incorporate something into the packages and extensions we distribute,
|
||||
we encourage you to pursue your passion project in your own fork,
|
||||
and share and discuss your thoughts and progress on the corresponding issue.
|
||||
|
@ -53,12 +53,12 @@ search for example for the [good-first-issue](https://github.com/microsoft/qshar
|
|||
Also, look for issues that have already been discussed in more detail,
|
||||
and check if you can help someone who has already started working on it.
|
||||
|
||||
Whether you want to help fixing bugs or add new features, please take a look at our general guide for [Contributing Code](https://docs.microsoft.com/quantum/contributing/code).
|
||||
Whether you want to help fixing bugs or add new features, please take a look at our general guide for [Contributing Code](https://docs.microsoft.com/azure/quantum/contributing-code).
|
||||
|
||||
## Contributing Documentation
|
||||
|
||||
If you are interested in contributing to conceptual documentation about Q#, please see the [MicrosoftDocs/quantum-docs-pr](https://github.com/MicrosoftDocs/quantum-docs-pr) repository.
|
||||
If you are interested in contributing API references, please see [Contributing Code](https://docs.microsoft.com/quantum/contributing/code) in the contribution guide.
|
||||
If you are interested in contributing API references, please see [Contributing Code](https://docs.microsoft.com/azure/quantum/contributing-code) in the contribution guide.
|
||||
|
||||
And last but not least:
|
||||
|
||||
|
|
12
README.md
12
README.md
|
@ -2,7 +2,7 @@
|
|||
|
||||
Welcome to the Microsoft Quantum Development Kit!
|
||||
|
||||
This repository contains the runtime components for the [Quantum Development Kit](https://docs.microsoft.com/quantum/).
|
||||
This repository contains the runtime components for the [Quantum Development Kit](https://docs.microsoft.com/azure/quantum/).
|
||||
It consists of the libraries and packages needed to create and simulate quantum applications using Q#.
|
||||
|
||||
- **[Azure/](./src/Azure/)**: Source for client package to create and manage jobs in Azure Quantum.
|
||||
|
@ -11,14 +11,14 @@ It consists of the libraries and packages needed to create and simulate quantum
|
|||
|
||||
## New to Quantum? ##
|
||||
|
||||
See the [introduction to quantum computing](https://docs.microsoft.com/quantum/concepts/) provided with the Quantum Development Kit.
|
||||
See the [introduction to quantum computing](https://docs.microsoft.com/azure/quantum/concepts-overview) provided with the Quantum Development Kit.
|
||||
|
||||
|
||||
## Installing the Quantum Development Kit
|
||||
|
||||
**If you're looking to use Q# to write quantum applications, please see the instructions on how to get started with using the [Quantum Development Kit](https://docs.microsoft.com/quantum/install-guide/) including the Q# compiler, language server, and development environment extensions.**
|
||||
**If you're looking to use Q# to write quantum applications, please see the instructions on how to get started with using the [Quantum Development Kit](https://docs.microsoft.com/azure/quantum/install-overview-qdk) including the Q# compiler, language server, and development environment extensions.**
|
||||
|
||||
Please see the [installation guide](https://docs.microsoft.com/quantum/install-guide) for further information on how to get started using the Quantum Development Kit to develop quantum applications.
|
||||
Please see the [installation guide](https://docs.microsoft.com/azure/quantum/install-overview-qdk) for further information on how to get started using the Quantum Development Kit to develop quantum applications.
|
||||
You may also visit our [Quantum](https://github.com/microsoft/quantum) repository, which offers a wide variety of samples on how to write quantum based programs.
|
||||
|
||||
|
||||
|
@ -81,7 +81,7 @@ All unit tests are part of the `Simulation.sln` solution. To run the tests:
|
|||
## Feedback ##
|
||||
|
||||
If you have feedback about the Q# simulators or any other runtime component, please let us know by filing a [new issue](https://github.com/microsoft/qsharp-runtime/issues/new)!
|
||||
If you have feedback about some other part of the Microsoft Quantum Development Kit, please see the [contribution guide](https://docs.microsoft.com/quantum/contributing/) for more information.
|
||||
If you have feedback about some other part of the Microsoft Quantum Development Kit, please see the [contribution guide](https://docs.microsoft.com/azure/quantum/contributing-overview) for more information.
|
||||
|
||||
|
||||
## Reporting Security Issues
|
||||
|
@ -111,4 +111,4 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
|
|||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
For more details, please see [CONTRIBUTING.md](./CONTRIBUTING.md), or the [contribution guide](https://docs.microsoft.com/quantum/contributing/).
|
||||
For more details, please see [CONTRIBUTING.md](./CONTRIBUTING.md), or the [contribution guide](https://docs.microsoft.com/azure/quantum/contributing-overview).
|
||||
|
|
|
@ -9,8 +9,8 @@
|
|||
</PropertyGroup>
|
||||
|
||||
<PropertyGroup>
|
||||
<ProjectUrl>https://docs.microsoft.com/quantum/</ProjectUrl>
|
||||
<PackageReleaseNotes>See: https://docs.microsoft.com/quantum/relnotes/</PackageReleaseNotes>
|
||||
<ProjectUrl>https://docs.microsoft.com/azure/quantum/</ProjectUrl>
|
||||
<PackageReleaseNotes>See: https://docs.microsoft.com/azure/quantum/qdk-relnotes/</PackageReleaseNotes>
|
||||
<PackageLicenseExpression>MIT</PackageLicenseExpression>
|
||||
<PackageProjectUrl>https://github.com/microsoft/qsharp-runtime</PackageProjectUrl>
|
||||
<PackageTags>Azure Quantum Q# QSharp</PackageTags>
|
||||
|
|
|
@ -8,13 +8,13 @@
|
|||
<owners>QuantumEngineering, Microsoft</owners>
|
||||
|
||||
<license type="expression">MIT</license>
|
||||
<projectUrl>https://docs.microsoft.com/en-us/quantum</projectUrl>
|
||||
<projectUrl>https://docs.microsoft.com/azure/quantum</projectUrl>
|
||||
<icon>images\qdk-nuget-icon.png</icon>
|
||||
|
||||
<requireLicenseAcceptance>false</requireLicenseAcceptance>
|
||||
<description>Provides tools for developing quantum algorithms in the Q# programming language.</description>
|
||||
|
||||
<releaseNotes>See: https://docs.microsoft.com/en-us/quantum/relnotes/</releaseNotes>
|
||||
<releaseNotes>See: https://docs.microsoft.com/azure/quantum/qdk-relnotes/</releaseNotes>
|
||||
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<tags>Quantum Q# QSharp</tags>
|
||||
|
|
|
@ -8,13 +8,13 @@
|
|||
<owners>QuantumEngineering, Microsoft</owners>
|
||||
|
||||
<license type="expression">MIT</license>
|
||||
<projectUrl>https://docs.microsoft.com/en-us/quantum</projectUrl>
|
||||
<projectUrl>https://docs.microsoft.com/azure/quantum</projectUrl>
|
||||
<icon>images\qdk-nuget-icon.png</icon>
|
||||
|
||||
<requireLicenseAcceptance>false</requireLicenseAcceptance>
|
||||
<description>C# code generation for executing Q# programs on a quantum simulator.</description>
|
||||
|
||||
<releaseNotes>See: https://docs.microsoft.com/en-us/quantum/relnotes/</releaseNotes>
|
||||
<releaseNotes>See: https://docs.microsoft.com/azure/quantum/qdk-relnotes/</releaseNotes>
|
||||
|
||||
<copyright>$copyright$</copyright>
|
||||
<tags>Quantum Q# QSharp</tags>
|
||||
|
|
|
@ -5,9 +5,9 @@
|
|||
<Authors>Microsoft</Authors>
|
||||
<Product>Microsoft Quantum Development Kit Preview</Product>
|
||||
<Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
|
||||
<PackageReleaseNotes>See: https://docs.microsoft.com/en-us/quantum/relnotes/</PackageReleaseNotes>
|
||||
<PackageReleaseNotes>See: https://docs.microsoft.com/azure/quantum/qdk-relnotes/</PackageReleaseNotes>
|
||||
<PackageLicenseExpression>MIT</PackageLicenseExpression>
|
||||
<ProjectUrl>https://docs.microsoft.com/quantum/</ProjectUrl>
|
||||
<ProjectUrl>https://docs.microsoft.com/azure/quantum/</ProjectUrl>
|
||||
<PackageProjectUrl>https://github.com/microsoft/qsharp-runtime</PackageProjectUrl>
|
||||
<PackageIcon>qdk-nuget-icon.png</PackageIcon>
|
||||
<PublishRepositoryUrl>true</PublishRepositoryUrl>
|
||||
|
|
|
@ -563,7 +563,7 @@ namespace Microsoft.Quantum.Simulation.Common
|
|||
void OnFail(System.Runtime.ExceptionServices.ExceptionDispatchInfo exceptionDispatchInfo);
|
||||
|
||||
/// <summary>
|
||||
/// Called when qubits are allocated by Q# <a href="https://docs.microsoft.com/quantum/language/statements#clean-qubits"><c>using</c></a> block.
|
||||
/// Called when qubits are allocated by Q# <a href="https://docs.microsoft.com/azure/quantum/user-guide/language/statements/quantummemorymanagement#use-statement"><c>using</c></a> block.
|
||||
/// </summary>
|
||||
/// <param name="qubits">Qubits that are being allocated</param>.
|
||||
/// <remarks>
|
||||
|
@ -573,7 +573,7 @@ namespace Microsoft.Quantum.Simulation.Common
|
|||
void OnAllocateQubits(IQArray<Qubit> qubits);
|
||||
|
||||
/// <summary>
|
||||
/// Called when qubits are released in Q# in the end of <a href="https://docs.microsoft.com/quantum/language/statements#clean-qubits"><c>using</c></a> block.
|
||||
/// Called when qubits are released in Q# in the end of <a href="https://docs.microsoft.com/azure/quantum/user-guide/language/statements/quantummemorymanagement#use-statement"><c>using</c></a> block.
|
||||
/// </summary>
|
||||
/// <param name="qubits">Qubits that are being released</param>.
|
||||
/// <remarks>
|
||||
|
@ -583,7 +583,7 @@ namespace Microsoft.Quantum.Simulation.Common
|
|||
void OnReleaseQubits(IQArray<Qubit> qubits);
|
||||
|
||||
/// <summary>
|
||||
/// Called when qubits are borrowed by Q# <a href="https://docs.microsoft.com/quantum/language/statements#dirty-qubits"><c>borrowing</c></a> block.
|
||||
/// Called when qubits are borrowed by Q# <a href="https://docs.microsoft.com/azure/quantum/user-guide/language/statements/quantummemorymanagement#borrow-statement"><c>borrowing</c></a> block.
|
||||
/// </summary>
|
||||
/// <param name="qubits">Qubits that are being borrowed</param>.
|
||||
/// <param name="allocatedForBorrowingCount">Number of qubits that have been allocated for borrowing. This might happen if there have not been enough already allocated qubits available for borrowing.</param>.
|
||||
|
@ -594,7 +594,7 @@ namespace Microsoft.Quantum.Simulation.Common
|
|||
void OnBorrowQubits(IQArray<Qubit> qubits, long allocatedForBorrowingCount);
|
||||
|
||||
/// <summary>
|
||||
/// Called when qubits are returned in the end of Q# <a href="https://docs.microsoft.com/quantum/language/statements#dirty-qubits"><c>borrowing</c></a> block.
|
||||
/// Called when qubits are returned in the end of Q# <a href="https://docs.microsoft.com/azure/quantum/user-guide/language/statements/quantummemorymanagement#borrow-statement"><c>borrowing</c></a> block.
|
||||
/// </summary>
|
||||
/// <param name="qubits">Qubits that have been borrowed and are now being returned</param>.
|
||||
/// <param name="releasedOnReturnCount">Number of qubits that have been released once returned. This might happen if they have been allocated only for borrowing.</param>.
|
||||
|
|
|
@ -7,11 +7,11 @@
|
|||
<authors>Microsoft</authors>
|
||||
<owners>QuantumEngineering, Microsoft</owners>
|
||||
<license type="expression">MIT</license>
|
||||
<projectUrl>https://docs.microsoft.com/en-us/quantum</projectUrl>
|
||||
<projectUrl>https://docs.microsoft.com/azure/quantum</projectUrl>
|
||||
<icon>images\qdk-nuget-icon.png</icon>
|
||||
<requireLicenseAcceptance>false</requireLicenseAcceptance>
|
||||
<description>Classical simulators of quantum computers for the Q# programming language.</description>
|
||||
<releaseNotes>See: https://docs.microsoft.com/en-us/quantum/relnotes/</releaseNotes>
|
||||
<releaseNotes>See: https://docs.microsoft.com/azure/quantum/qdk-relnotes/</releaseNotes>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<tags>Quantum Q# QSharp</tags>
|
||||
</metadata>
|
||||
|
|
|
@ -8,13 +8,13 @@
|
|||
<owners>QuantumEngineering, Microsoft</owners>
|
||||
|
||||
<license type="expression">MIT</license>
|
||||
<projectUrl>https://docs.microsoft.com/en-us/quantum</projectUrl>
|
||||
<projectUrl>https://docs.microsoft.com/azure/quantum</projectUrl>
|
||||
<icon>images\qdk-nuget-icon.png</icon>
|
||||
|
||||
<requireLicenseAcceptance>false</requireLicenseAcceptance>
|
||||
<description>Library for testing Q# programs and algorithms using the xUnit framework.</description>
|
||||
|
||||
<releaseNotes>See: https://docs.microsoft.com/en-us/quantum/relnotes/</releaseNotes>
|
||||
<releaseNotes>See: https://docs.microsoft.com/azure/quantum/qdk-relnotes/</releaseNotes>
|
||||
|
||||
<copyright>$copyright$</copyright>
|
||||
<tags>Quantum Q# QSharp test xunit</tags>
|
||||
|
|
Загрузка…
Ссылка в новой задаче