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

Update supported admonition types #124

Merged
merged 2 commits into from
Jan 5, 2025
Merged

Update supported admonition types #124

merged 2 commits into from
Jan 5, 2025

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Jan 4, 2025

Summary

Per #106 (comment), supported admonition types should be Note, Warning, Important, and Tip. This list was determined after analyzing supported admonitions in our current Asciidoc system and cross-referencing with our style guide.

This PR removes support for Caution and Attention and replaces them with support for Warning and Important. It also adds a missing AdmonitionUnsupportedTest.

I've updated #3 to reflect these supported admonition types as that issue is referenced in the error logs.

Results

Tested locally with:

dotnet publish "src/docs-builder/docs-builder.csproj" -c Release -o .artifacts/publish \
    --self-contained true /p:PublishTrimmed=true /p:PublishSingleFile=false /p:PublishAot=true -a arm64

./.artifacts/publish/docs-builder serve
Screenshot 2025-01-03 at 10 25 37 PM Screenshot 2025-01-03 at 10 25 32 PM

@bmorelli25 bmorelli25 requested a review from Mpdreamz January 4, 2025 06:28
@bmorelli25
Copy link
Member Author

I'm not sure how to get the test to pass as it uses the docs-builder image.

Copy link
Member

@Mpdreamz Mpdreamz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm!

We'll have to switch over to validate the docs after we build using the artifacts to break the chicken and egg feedback loop.

The current GitHub action we use is for everyone else.

@Mpdreamz Mpdreamz merged commit 5e387eb into main Jan 5, 2025
3 of 4 checks passed
@Mpdreamz Mpdreamz deleted the try-coding-out branch January 5, 2025 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants