MicrosoftDocs/feedback

Cannot Test Documentation Yaml Structure Changes

Opened this issue · 1 comments

Afternoon team,

I recently came across this git repo, and I think it is a great idea to expose documentation to the community. I would love to help restructure the documentation on DirectX HLSL, which has for many years proven to be very difficult to navigate for myself and colleagues.

The first and most important step to improving the documentation (I feel) is going to be restructuring the page hierarchy in the table of contents, which seems to be entirely built using yaml. Unfortunately, I have been unable to find any means to preview the complete website including the table of contents, not just single markdown files. Making larger structure changes without this would be very risky.

I have taken a fair amount of time investigating VSCode plugins, and the best I have found previews markdown, but cannot preview the yaml page hierarchy. The repo root contains a "openpublishing.build.ps1" script which I assume is related for building the final webpages, but it unfortunately errors after trying to access some blob on a microsoft server. I assume it is trying to access some internal assets that are not open publicly.

Please provide guidance on the recommended approach for validating page structure changes.

Russell

Thank you for opening an issue! One of our team members will get back to you with additional information.

If this is a product issue, please close this issue and contact the product's support instead. For a list of support websites, see Support for Microsoft products and apps.