qsharp icon indicating copy to clipboard operation
qsharp copied to clipboard

Doc Gen Improvements

Open ScottCarda-MS opened this issue 11 months ago • 1 comments

The Docs Team has suggested several improvements to the doc generator tool.

  • [x] Colons in the metadata values will break the doc team's yaml interpreter. There were a handful of generated files that have "Warning:" or "Note:" in the summary section. Currently, the docs team has to manually fix this in the file before publishing. The suggestion here is to wrap the summary section of the metadata in quotations. (#1206)
  • [ ] There are about two dozen files that have "See Also" references to other topics. It would be nice if those could be live links.
  • [ ] Files for Namespaces containing lists of the namespaces's contents (along with links), along with changing the "Namespace" section of the files into links to the namespace file.

ScottCarda-MS avatar Feb 26 '24 18:02 ScottCarda-MS

@ScottCarda-MS , I would like to work on this issue.

Pulkit1822 avatar May 10 '24 21:05 Pulkit1822