(#3446) (ENGTASKS-3631) Update GenerateDocs.ps1 #3447
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This can be reviewed, but it may not be ready to merge until the Astro bits are ready to go into docs. |
|
This can not be released until after this PR has been merged: chocolatey/docs#993 The merging of this PR may require more changes to be made here, and changes to the files in the PR above might need to be fixed up to support Astro. |
st3phhays
changed the title
st3phhays
changed the title
st3phhays
commented
Jun 11, 2024
The GenerateDocs.ps1 file has been modified to support the Astro
framework that docs.chocolatey.org will be using.
- Frontmatter keys are lowercase
- import the Xref Component
- Switch links to use the Xref Component
- Ensure all code is within code blocks and not 4 spaces
(.mdx does not recognize code blocks as 4 spaces)
- Ensure NOTE and WARNINGS are formatted correctly
- Update comments to use `{/* stuff */}` instead of `<!-- stuff -->`
- Change file format to `.mdx`
Strip out some things platyps falls over on, and add some things back in after platyPS is done that we want/need the docs site to have.
Use xml to process xref nodes in the document.
|
I am going to go ahead and merge this, since we don't need to wait on the CI builds passing. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description Of Changes
The GenerateDocs.ps1 file has been modified to support the Astro framework that docs.chocolatey.org will be using.
{/* stuff */}instead of<!-- stuff -->.mdxMotivation and Context
The documentation site has been switched to the Astro framework, and the changes here allow it to build.
Testing
GenerateDocs.ps1file and copied the results into the docs repo.Change Types Made
Change Checklist
Related Issue
Fixes #3446