Skip to content

Docs: use Docsy alert shortcode for notes and warnings - #4703

Open
aravindtga wants to merge 1 commit into
kptdev:mainfrom
Nordix:use-docsy-alert-shortcode
Open

Docs: use Docsy alert shortcode for notes and warnings#4703
aravindtga wants to merge 1 commit into
kptdev:mainfrom
Nordix:use-docsy-alert-shortcode

Conversation

@aravindtga

Copy link
Copy Markdown
Contributor

Description

Migrate all notes and warnings in the kpt documentation to use the Docs {{% alert %}} shortcode, aligning with the porch documentation style.

This change:

  • Converts 5 usages of the custom {{< warning >}} shortcode to {{% alert %}}
  • Converts 6 plain-text Note:/**Warning**: patterns to {{% alert %}}
  • Deletes the custom documentation/layouts/shortcodes/warning.html (replaced by Docsy built-in)
  • Fixes $primary SCSS variable from #fff to $kpt-dark-blue so color="primary" alerts render as visible blue (matching porch)
  • Hardcodes navbar background to #fff in _nav.scss (matching porch) so changing $primary doesn't affect the navbar

Motivation

Addresses #4533

The kpt documentation had inconsistent note/warning formatting:

  • A custom warning.html shortcode with non-standard syntax
  • Plain-text bold **Note:** and **Warning:** without visual styling
  • The $primary CSS variable was set to white, making color="primary" alerts invisible

After this change, kpt uses the identical alert pattern as porch:

{{% alert title="Note" color="primary" %}}
{{% alert title="Warning" color="warning" %}}
{{% alert title="Critical" color="danger" %}}

AI usage

I have used AI in the creation of this PR.

I have used the following AI tools:

  • Kiro (Claude) to identify unconverted patterns, compare with porch styling, and generate the changes

Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
@netlify

netlify Bot commented Aug 14, 2026

Copy link
Copy Markdown

Deploy Preview for kptdocs ready!

Name Link
🔨 Latest commit ca2a686
🔍 Latest deploy log https://app.netlify.com/projects/kptdocs/deploys/6a7f0abd4c8f7100078e4afb
😎 Deploy Preview https://deploy-preview-4703--kptdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@aravindtga aravindtga self-assigned this Aug 14, 2026
@aravindtga
aravindtga marked this pull request as ready for review August 14, 2026 12:33
@aravindtga
aravindtga requested review from a team August 14, 2026 12:34
@dosubot dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. documentation Improvements or additions to documentation labels Aug 14, 2026
@dosubot dosubot Bot added the lgtm label Aug 19, 2026
@aravindtga
aravindtga requested a review from a team August 20, 2026 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants