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

web: Fix inline documentation rendering #13379

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

GirlBossRush
Copy link
Contributor

Details

This PR addresses a collection of rendering bugs for documentation sourced from our Docusaurus pages. While this doesn't yet cover all possible visual discrepancies, the changes here bring us much closer to the expected output seen on Docusaurus.

  • Fixes issue where Mermaid diagrams do not render.
  • Fixes issue where links occasionally link to missing index page.
  • Fixes link colors in dark mode.
  • Fixes anchored links triggering router.

Before

Screenshot 2025-03-04 at 01 36 54 Screenshot 2025-03-04 at 01 36 59 Screenshot 2025-03-04 at 01 39 30

After

Screenshot 2025-03-04 at 01 22 46 Screenshot 2025-03-04 at 01 36 01

Checklist

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)

If applicable

  • The documentation has been updated
  • The documentation has been formatted (make website)

@GirlBossRush GirlBossRush added documentation Improvements or additions to documentation bug/confirmed Confirmed bugs labels Mar 4, 2025
@GirlBossRush GirlBossRush self-assigned this Mar 4, 2025
@GirlBossRush GirlBossRush requested review from a team as code owners March 4, 2025 00:43
Copy link

netlify bot commented Mar 4, 2025

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit ee154b6
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67c8a12494f004000828707b
😎 Deploy Preview https://deploy-preview-13379--authentik-storybook.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Mar 4, 2025

Deploy Preview for authentik-docs canceled.

Name Link
🔨 Latest commit ee154b6
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67c8a1248fa2ef0008a58b17

Copy link

codecov bot commented Mar 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.74%. Comparing base (7f474cd) to head (ee154b6).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #13379      +/-   ##
==========================================
+ Coverage   92.68%   92.74%   +0.06%     
==========================================
  Files         793      793              
  Lines       40347    40347              
==========================================
+ Hits        37394    37419      +25     
+ Misses       2953     2928      -25     
Flag Coverage Δ
e2e 48.00% <ø> (+0.08%) ⬆️
integration 24.08% <ø> (ø)
unit 90.46% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@GirlBossRush GirlBossRush force-pushed the inline-markdown-fixes branch 3 times, most recently from aad5cd5 to c9debb8 Compare March 4, 2025 16:06
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

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

Thanks @GirlBossRush for making Docs much purrtier! What exactly is "Fixes anchored links triggering router."??

@GirlBossRush GirlBossRush force-pushed the inline-markdown-fixes branch from c9debb8 to 517314c Compare March 5, 2025 17:12
- Fix issue where Mermaid diagrams do not render.
- Fix link colors in dark mode.
- Fix anchored links triggering router.
- Fix issue where links occasionally link to missing page.
@GirlBossRush GirlBossRush force-pushed the inline-markdown-fixes branch from 517314c to ee154b6 Compare March 5, 2025 19:08
@GirlBossRush
Copy link
Contributor Author

@BeryJu Ready for review 👍🏻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug/confirmed Confirmed bugs documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants