Prerequisites suggestion#1174
Merged
christopher-hakkaart merged 1 commit intojustine-templatefrom Mar 4, 2026
Merged
Conversation
Member
christopher-hakkaart
commented
Mar 4, 2026
christopher-hakkaart
commented
- Make "Prerequisites" the title
- Add a tag to that it's indexed
- Add scroll css to the anchor so that it sits above the admonition
christopher-hakkaart
requested review from
a team,
justinegeffen and
llewellyn-sl
as code owners
justinegeffen
approved these changes
Mar 4, 2026
justinegeffen
added a commit
that referenced
this pull request
Mar 4, 2026
#1154) * Testing Clauded pre-reqs * docs: Convert Prerequisites sections to admonitions in enterprise docs Convert all Prerequisites sections from headings to info admonitions across Platform Enterprise documentation and version 25.3. This provides better visual consistency and improves the user experience by making prerequisite information more prominent and accessible. Changes: - Convert 40 files from ## Prerequisites headings to :::info admonitions - Add HTML anchors (<a id="prerequisites"></a>) to preserve backward compatibility for internal links - Apply changes to both current and versioned (25.3) documentation Files updated: - Installation docs (Platform, Studios, Groundswell) - Authentication provider docs (Email, Entra, GitHub, Google, Keycloak, Okta) - Manual Azure Batch setup documentation Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * fix: Use heading-based anchors in Prerequisites admonitions Replace HTML anchors with Markdown heading anchors to resolve Docusaurus broken anchor warnings. This change allows builds to pass with FAIL_ON_BROKEN_LINKS=true enabled in CI/CD pipelines. Change format from: <a id="prerequisites"></a> :::info[**Prerequisites**] To: :::info ## Prerequisites {#prerequisites} This approach: - Eliminates broken anchor warnings in Docusaurus builds - Preserves backward compatibility for #prerequisites links - Uses native Docusaurus anchor detection - Allows successful deployment with strict link checking Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * docs: Use span with id for Prerequisites admonition anchors Replace heading-based anchors with span elements containing IDs inside the admonition title. This maintains the clean "Prerequisites" title styling while preserving anchor functionality for internal links. Format: :::info <span id="prerequisites">**Prerequisites**</span> This approach provides: - Clean admonition title (shows "Prerequisites" not "info") - Working anchor navigation (#prerequisites) - Build succeeds (warnings only, not errors) - Compatible with existing internal links Note: Docusaurus static analyzer shows warnings for span IDs, but these are non-blocking and the anchors work correctly in browsers. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fixed broken anchor alerts * Additional fixes * update preview file * Suggestion (#1174) --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com> Co-authored-by: Chris Hakkaart <chris.hakkaart@seqera.io>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.