Skip to content

chore(docs): fix url asset paths#151

Merged
coryrylan merged 1 commit into
mainfrom
topic-url-fixes
Jun 23, 2026
Merged

chore(docs): fix url asset paths#151
coryrylan merged 1 commit into
mainfrom
topic-url-fixes

Conversation

@coryrylan

@coryrylan coryrylan commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Bug Fixes

    • Fixed image asset resolution by standardizing paths across components and documentation.
  • Documentation

    • Updated internal documentation links to reflect new path structure.
    • Removed Brand theme documentation section from Themes guide.
    • Updated navigation references in integration guides.

Signed-off-by: Cory Rylan <crylan@nvidia.com>
@coryrylan coryrylan requested a review from johnyanarella June 23, 2026 20:20
@coryrylan coryrylan self-assigned this Jun 23, 2026
@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: abc46ebb-3245-4cc9-b830-4a8435c5836a

📥 Commits

Reviewing files that changed from the base of the PR and between eddbd96 and c662de8.

📒 Files selected for processing (12)
  • projects/core/src/avatar/avatar.examples.ts
  • projects/core/src/card/card.examples.ts
  • projects/core/src/page/page.examples.ts
  • projects/core/src/progressive-filter-chip/progressive-filter-chip.examples.ts
  • projects/internals/patterns/src/templates.examples.ts
  • projects/site/src/_11ty/layouts/links.test.ts
  • projects/site/src/_internal/theme-preview/theme-preview.ts
  • projects/site/src/docs/about/contributions.md
  • projects/site/src/docs/about/requests.md
  • projects/site/src/docs/about/support.md
  • projects/site/src/docs/foundations/themes/index.11ty.js
  • projects/site/src/docs/integrations/angular.md
💤 Files with no reviewable changes (1)
  • projects/site/src/docs/foundations/themes/index.11ty.js

📝 Walkthrough

Walkthrough

Relative static/images/... asset paths are changed to absolute /static/images/... paths across six example and site template files. The internal-link validator test is updated to include static in its segment list. Several documentation links are corrected (installation path, Angular custom-control route, playground URL), and the Brand theme section is removed from the Themes page.

Changes

Static Asset Paths and Documentation Fixes

Layer / File(s) Summary
Example and site template image paths made absolute
projects/core/src/avatar/avatar.examples.ts, projects/core/src/card/card.examples.ts, projects/core/src/page/page.examples.ts, projects/core/src/progressive-filter-chip/progressive-filter-chip.examples.ts, projects/internals/patterns/src/templates.examples.ts, projects/site/src/_internal/theme-preview/theme-preview.ts
src attributes referencing static/images/... are updated to /static/images/... across all example and site component templates.
Internal-link validator updated for static segment
projects/site/src/_11ty/layouts/links.test.ts
Hardcoded regex literals are replaced by patterns constructed from a shared AUTHORED_SITE_SEGMENTS constant that now includes static, covering both HTML attribute and JS string link forms.
Doc link corrections and Brand theme removal
projects/site/src/docs/about/contributions.md, projects/site/src/docs/about/requests.md, projects/site/src/docs/about/support.md, projects/site/src/docs/integrations/angular.md, projects/site/src/docs/foundations/themes/index.11ty.js
Flowchart image refs are made absolute; installation links are updated to /docs/integrations/installation/; the Angular custom-control link and playground link targets are corrected; the Brand theme section and getThemeDemo('brand-dark') call are deleted.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • NVIDIA/elements#130: Touches the same projects/site/src/_11ty/layouts/links.test.ts file, updating the internal-link validation regex patterns for base/root-relative URL handling.

Suggested labels

scope(core), scope(internals), scope(docs)

Suggested reviewers

  • jareddlc
  • johnyanarella
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'chore(docs): fix url asset paths' accurately summarizes the primary change across all modified files—converting relative asset paths to absolute paths throughout documentation and component examples.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch topic-url-fixes

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

projects/core/src/avatar/avatar.examples.ts

ESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox.

projects/core/src/card/card.examples.ts

ESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox.

projects/core/src/page/page.examples.ts

ESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox.

  • 4 others

Comment @coderabbitai help to get the list of available commands.

@coryrylan coryrylan merged commit 1cda122 into main Jun 23, 2026
13 checks passed
@coryrylan coryrylan deleted the topic-url-fixes branch June 23, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants