Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cannot Test Documentation Yaml Structure Changes #3989

Open
fheavr opened this issue Feb 4, 2024 · 1 comment
Open

Cannot Test Documentation Yaml Structure Changes #3989

fheavr opened this issue Feb 4, 2024 · 1 comment
Labels
bug Something isn't working Pri3

Comments

@fheavr
Copy link

fheavr commented Feb 4, 2024

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

@fheavr fheavr added the bug Something isn't working label Feb 4, 2024
Copy link

welcome bot commented Feb 4, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working Pri3
Projects
None yet
Development

No branches or pull requests

1 participant