Feat/doc site update#75
Merged
Merged
Conversation
…-update to CI trigger; skip Pages deploy on feature branches
… to flag all internal links as external, showing globe icon on every nav item
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Nexus documentation site configuration and CI workflows to fix a docs build failure/regression (external-link globe icons showing broadly) and to prepare GitHub Actions workflows for the upcoming Node.js 24 runtime cutover.
Changes:
- Updated MkDocs
site_urlto the production docs domain. - Added CSS to suppress Material’s auto-injected external-link SVG icons in navigation/TOC.
- Updated GitHub Actions workflows to opt into Node.js 24 for JavaScript-based actions and adjusted docs workflow behavior for non-
mainbuilds.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Updates canonical site URL for the deployed documentation site. |
| docs/stylesheets/extra.css | Adds CSS intended to hide Material’s injected external-link globe icons in nav/TOC. |
| docs/overrides/.gitkeep | Adds a sentinel file to keep the docs/overrides/ directory tracked. |
| .github/workflows/docs.yml | Updates docs workflow triggers, deploy gating, and opts into Node.js 24 for JS actions. |
| .github/workflows/docker-publish.yml | Opts Docker publish workflow into Node.js 24 for JS actions. |
| .github/workflows/release.yml | Opts release workflow into Node.js 24 for JS actions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+801
to
+806
| /* Broad catch-all for any remaining injected SVG globe in sidebars */ | ||
| .md-sidebar .md-nav__link > svg[viewBox] { | ||
| display: none !important; | ||
| } | ||
|
|
||
|
|
Comment on lines
4
to
8
| push: | ||
| branches: | ||
| - main | ||
| - feat/doc-site-update | ||
| paths: |
Comment on lines
6
to
+21
| @@ -15,6 +16,9 @@ permissions: | |||
| pages: write # deploy to GitHub Pages | |||
| id-token: write # OIDC token for Pages deployment | |||
|
|
|||
| env: | |||
| FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true | |||
|
|
|||
Comment on lines
1
to
6
| site_name: Nexus | ||
| site_description: Provider-agnostic credential brokering for autonomous agents. Built by Prescott Data. | ||
| site_url: https://prescott-data.github.io/nexus-framework/ | ||
| site_url: https://nexus.developers.prescottdata.io/ | ||
| repo_url: https://github.com/Prescott-Data/nexus-framework | ||
| repo_name: Prescott-Data/nexus-framework | ||
| edit_uri: edit/main/docs/ |
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
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.
Pull Request
Description
Fixes the Nexus documentation site (
nexus.developers.prescottdata.io) build failure and a visual regression where the globe icon was appearing on every sidebar and table of contents item. Also modernises the CI workflows to opt into Node.js 24 ahead of the GitHub Actions forced cutover on June 2, 2026.Type of Change
Changes Made
mkdocs.ymlsite_urlfrom the old GitHub Pages URL to the actual deployed domain (nexus.developers.prescottdata.io). This was the root cause of the globe icon appearing on all nav items — Material's instant-navigation JS compared all internal hrefs against the wrong origin and flagged them as external.docs/overrides/.gitkeepoverrides/directory. Without this the directory was missing after a fresh CI checkout, causingmkdocs buildto abort withcustom_dir does not exist.docs/stylesheets/extra.csssvg.md-iconglobe from the primary sidebar, TOC sidebar, and mobile drawer. Belt-and-suspenders fix alongside thesite_urlcorrection..github/workflows/docs.ymlfeat/doc-site-updateto the branch trigger list; conditioned the Pages upload/deploy jobs to only run onmainso feature branch builds validate without trying to deploy. AddedFORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true..github/workflows/docker-publish.ymlFORCE_JAVASCRIPT_ACTIONS_TO_NODE24: trueto existingenvblock..github/workflows/release.ymlFORCE_JAVASCRIPT_ACTIONS_TO_NODE24: trueenv block.How to Test
nexus.developers.prescottdata.ioBuildjob passes on this branch without thecustom_dir does not existerrorMigration / Breaking Changes
Checklist
gofmtapplied) — N/A, no Go changes in this PR