Open dime10 opened 3 years ago
As discussed offline, each of these comes from projects that should not be exposing API documentation at all. Most of these seem to be from qdk-private, such that it would be good to involve the compiler and runtime team. +@bettinaheim for awareness.
I ran the test again and looks like most broken links are gone, with the exception of these 3 present in 20 pages:
https://nuget.org/packages/random-walk-pe https://nuget.org/packages/Tests.Research https://nuget.org/packages/qsp
Fulll report:
Summary of broken links:
'file:.../quantum-api/api/qsharp/microsoft.quantum.research.samples.exporacle.md' has 1 broken link(s):
https://nuget.org/packages/random-walk-pe
'file:.../quantum-api/api/qsharp/systemtestjwoptimizedes.pqtermabfromgeneralhamiltoniantestop.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
'file:.../quantum-api/api/qsharp/microsoft.quantum.research.samples.phaseestimationsample.md' has 1 broken link(s):
https://nuget.org/packages/random-walk-pe
'file:.../quantum-api/api/qsharp/microsoft.quantum.research.samples.samplehamiltonianevolutionbyqsp.md' has 1 broken link(s):
https://nuget.org/packages/qsp
'file:.../quantum-api/api/qsharp/systemtestjwoptimizedes.pqqrtermfromgeneralhamiltoniantestop.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
'file:.../quantum-api/api/qsharp/microsoft.quantum.research.samples.applyblockencodedhamiltonian.md' has 1 broken link(s):
https://nuget.org/packages/qsp
'file:.../quantum-api/api/qsharp/microsoft.quantum.research.tests.checkbayesianperandomwalk.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
'file:.../quantum-api/api/qsharp/systemtestjwoptimizedes.pqtermacfromgeneralhamiltoniantestop.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
'file:.../quantum-api/api/qsharp/systemtestjwoptimizedes.jwoptimizedapplytrotterstep.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
'file:.../quantum-api/api/qsharp/systemtestjwoptimizedes.pqtermacfromliquidorbitaltestop.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
'file:.../quantum-api/api/qsharp/microsoft.quantum.research.samples.evolvebytrotter.md' has 1 broken link(s):
https://nuget.org/packages/qsp
'file:.../quantum-api/api/qsharp/systemtestjwoptimizedes.pqqptermfromliquidorbitaltestop.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
'file:.../quantum-api/api/qsharp/systemtestjwoptimizedes.pqrstermfromliquidorbitaltestop.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
'file:.../quantum-api/api/qsharp/systemtestjwoptimizedes.pptermfromliquidorbitaltestop.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
'file:.../quantum-api/api/qsharp/systemtestjwoptimizedes.pqrstermfromgeneralhamiltoniantestop.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
'file:.../quantum-api/api/qsharp/systemtestjwoptimizedes.pptermfromgeneralhamiltoniantestop.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
'file:.../quantum-api/api/qsharp/microsoft.quantum.research.samples.quantumsignalprocessonequator.md' has 1 broken link(s):
https://nuget.org/packages/qsp
'file:.../quantum-api/api/qsharp/systemtestjwoptimizedes.pqqptermfromgeneralhamiltoniantestop.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
'file:.../quantum-api/api/qsharp/systemtestjwoptimizedes.pqtermabfromliquidorbitaltestop.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
'file:.../quantum-api/api/qsharp/systemtestjwoptimizedes.pqqrtermfromliquidorbitaltestop.md' has 1 broken link(s):
https://nuget.org/packages/Tests.Research
I ran the test again and looks like most broken links are gone, with the exception of these 3 present in 20 pages:
https://nuget.org/packages/random-walk-pe https://nuget.org/packages/Tests.Research https://nuget.org/packages/qsp
Ah, those would have come from the quantum-nc repo, let me go fix that. Those links should then be repaired as part of the May release.
See https://github.com/microsoft/Quantum-NC/pull/59 for a fix.
I ran a broken links check on the repo and it reported 16 broken links across 391 files. All of them are links to NuGet packages. I doublechecked them manually and they indeed return a 404.
@cgranade
Broken links:
https://nuget.org/packages/HoneywellExe https://nuget.org/packages/IntrinsicTests https://nuget.org/packages/IonQExe https://nuget.org/packages/QCIExe https://nuget.org/packages/qir-gen https://nuget.org/packages/qir-standalone-input-reference https://nuget.org/packages/qir-test-random https://nuget.org/packages/qir-test-simulator https://nuget.org/packages/QSharpExe https://nuget.org/packages/qsp https://nuget.org/packages/random-walk-pe https://nuget.org/packages/TargetedExe https://nuget.org/packages/Tests.Microsoft.Quantum.Simulation.QCTraceSimulatorRuntime https://nuget.org/packages/Tests.Research https://nuget.org/packages/tracer-qir https://nuget.org/packages/UnitTests
Here is the full report: