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.

Sign up for GitHub

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

Jump to bottom

Update GenerateDocs.ps1 to support the Astro Framework #3446

Open
2 of 9 tasks
st3phhays opened this issue May 17, 2024 · 0 comments · May be fixed by #3447
Open
2 of 9 tasks

Update GenerateDocs.ps1 to support the Astro Framework #3446

st3phhays opened this issue May 17, 2024 · 0 comments · May be fixed by #3447
Assignees
@st3phhays
Labels
3 - Review Documentation

Comments

@st3phhays
Copy link
Member

st3phhays commented May 17, 2024 •
edited

Checklist

  • I have verified this is the correct repository for opening this issue.
  • I have verified no other issues exist related to my request.

Is Your Feature Request Related To A Problem? Please describe.

We are utilizing the Astro framework on docs.chocolatey.org, and there are some things that will need to be updated on the generated .md files in order for Astro to compile.

Describe The Solution. Why is it needed?

The GenerateDocs.ps1 file should:

  • 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

Additional Context

No response

Related Issues
@st3phhays st3phhays self-assigned this May 17, 2024
This was referenced May 17, 2024
Open
Open
@sync-by-unito sync-by-unito bot mentioned this issue May 17, 2024
Open
2 tasks
This was referenced May 17, 2024
Open
Open
Draft
st3phhays added a commit to st3phhays/choco that referenced this issue May 20, 2024
@st3phhays
(chocolatey#3446) Update GenerateDocs.ps1
dfe900e 
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`
@st3phhays st3phhays linked a pull request May 20, 2024 that will close this issue
Open
10 tasks
st3phhays added a commit to st3phhays/choco that referenced this issue May 20, 2024
@st3phhays
(chocolatey#3446) Update GenerateDocs.ps1
f857f04 
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`
st3phhays added a commit to st3phhays/choco that referenced this issue May 20, 2024
@st3phhays
(chocolatey#3446) Update GenerateDocs.ps1
ced88da 
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`
st3phhays added a commit to st3phhays/choco that referenced this issue Jun 4, 2024
@st3phhays
(chocolatey#3446) Update GenerateDocs.ps1
6b70d90 
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`
st3phhays added a commit to st3phhays/choco that referenced this issue Jun 7, 2024
@st3phhays
(chocolatey#3446) Update GenerateDocs.ps1
beffb49 
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`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@st3phhays st3phhays

Labels
3 - Review Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

(#3446) (ENGTASKS-3631) Update GenerateDocs.ps1 st3phhays/choco
1 participant
@st3phhays