Skip to content

chore(docs): update notice file#171

Merged
coryrylan merged 2 commits into
mainfrom
topic-logo-fixes
Jul 2, 2026
Merged

chore(docs): update notice file#171
coryrylan merged 2 commits into
mainfrom
topic-logo-fixes

Conversation

@coryrylan

@coryrylan coryrylan commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator
  • add missing site ico
  • add additional notice details for documentation usage of third party logos

Summary by CodeRabbit

  • New Features
    • Added a dedicated “Third-Party Logos Notice” link in the main repository NOTICE text and updated documentation logo ownership details.
  • Bug Fixes
    • Updated the site favicon to a hosted image.
    • Improved HTML minification reliability, including CSS minification handled by the HTML engine.
  • Documentation
    • Adjusted NOTICE rendering so the third-party logo guidance appears in the correct section.
  • Tests
    • Added coverage for parsing minified/variant description meta tags.
  • Chores
    • Updated Vale styling rules for NOTICE files, refreshed SSR allowlist generation, updated context link data, and streamlined site dev dependencies.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

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: e876140b-fca9-4e7e-80bb-93cff3978224

📥 Commits

Reviewing files that changed from the base of the PR and between ac66bc9 and f7c2717.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (4)
  • projects/site/eleventy.config.js
  • projects/site/package.json
  • projects/site/src/_11ty/layouts/metadata.test.ts
  • projects/site/src/_11ty/transforms/html-minify.js
💤 Files with no reviewable changes (2)
  • projects/site/package.json
  • projects/site/eleventy.config.js

📝 Walkthrough

Walkthrough

Adds a third-party logos notice link to root notice generation, updates notice and favicon content, changes site HTML minification and SSR allowlists, and adds a context7 JSON config.

Changes

Documentation Logos Notice and Favicon Update

Layer / File(s) Summary
Root notice template accepts documentation logos notice
projects/internals/ci/notice/template.js
renderRootNotice takes a documentation logos notice path and inserts a linked logos sentence in both empty and non-empty outputs.
Notice generator wires documentation logos notice path
projects/internals/ci/notice/index.js
Defines the documentation logos notice path, verifies it exists, and passes it into renderRootNotice when generating the root notice.
Notice content and favicon updates
NOTICE.md, projects/site/public/static/images/integrations/NOTICE.md, projects/site/src/_11ty/layouts/common.js
Root NOTICE.md adds a third-party logos reference, the integrations NOTICE.md adds an NVIDIA owner row for logo.svg, and the site favicon URL changes.
Vale style override for NOTICE.md
.vale.ini
Adds per-file overrides for NOTICE.md and nested NOTICE.md files that clear BasedOnStyles.

Site Minification and SSR Allowlist Updates

Layer / File(s) Summary
HTML minify transform uses async CSS-aware minification
projects/site/src/_11ty/transforms/html-minify.js
htmlMinifyTransform becomes async, minifyHTML awaits the minifier call, and html-minifier-next is configured to minify CSS directly.
Site dependency and SSR allowlist changes
projects/site/package.json, projects/site/eleventy.config.js
lightningcss is removed from devDependencies, and the SSR entrypoint allowlist is updated to include @nvidia-elements/core/card while dropping @nvidia-elements/core/button and @nvidia-elements/core/icon-button from that set.

Context7 configuration

Layer / File(s) Summary
Context7 config file
context7.json
Adds a JSON object with fixed url and public_key values.

Estimated code review effort: 3 (Moderate) | ~25 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the primary docs/notice update and is concise and specific enough for the main change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ 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-logo-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/site/src/_11ty/layouts/metadata.test.ts

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

projects/site/src/_11ty/transforms/html-minify.js

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


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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@projects/site/public/static/images/integrations/NOTICE.md`:
- Line 9: The NOTICE table in the static images integrations list is no longer
alphabetically ordered because the logo.svg entry is placed first. Reorder the
row in the table so logo.svg appears in its correct alphabetical position
alongside the other filenames, using the existing NOTICE.md table structure as
the reference.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: b919d7b4-43d6-4eec-b44c-e904985c49ef

📥 Commits

Reviewing files that changed from the base of the PR and between e85bd40 and 8c3bd93.

⛔ Files ignored due to path filters (1)
  • projects/site/public/favicon.svg is excluded by !**/*.svg
📒 Files selected for processing (6)
  • .vale.ini
  • NOTICE.md
  • projects/internals/ci/notice/index.js
  • projects/internals/ci/notice/template.js
  • projects/site/public/static/images/integrations/NOTICE.md
  • projects/site/src/_11ty/layouts/common.js

Comment thread projects/site/public/static/images/integrations/NOTICE.md Outdated
- add missing site ico
- add additional notice details for documentation usage of third party logos

Signed-off-by: Cory Rylan <crylan@nvidia.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@projects/site/src/_11ty/layouts/common.js`:
- Line 46: The favicon in the common layout is hotlinking an external GitHub
avatar URL, so replace the hardcoded href in the layout’s favicon link with a
locally served static asset. Update the `common.js` template to point to the
site’s own favicon file and keep the `<link rel="icon">` entry using a stable
self-hosted path, so page loads no longer depend on the external avatar service.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 584a5520-084c-416c-a407-e3317ec1317d

📥 Commits

Reviewing files that changed from the base of the PR and between 8c3bd93 and aea5b9b.

⛔ Files ignored due to path filters (1)
  • projects/site/public/favicon.svg is excluded by !**/*.svg
📒 Files selected for processing (7)
  • .vale.ini
  • NOTICE.md
  • context7.json
  • projects/internals/ci/notice/index.js
  • projects/internals/ci/notice/template.js
  • projects/site/public/static/images/integrations/NOTICE.md
  • projects/site/src/_11ty/layouts/common.js

Comment thread projects/site/src/_11ty/layouts/common.js
@github-actions github-actions Bot added the dependencies Pull requests that update a dependency file label Jul 2, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@projects/site/src/_11ty/transforms/html-minify.js`:
- Around line 8-13: The html-minify transform is swallowing minification
failures without any diagnostic, so update the try/catch around minifyHTML in
the transform function to log the caught error before falling back to the
original content. Keep the existing fallback behavior for watch/build safety,
but make sure the catch path includes a clear error message and the actual
exception details so failures are visible in build logs.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 994c8a2a-ab71-453b-b80b-c38d514f2bbc

📥 Commits

Reviewing files that changed from the base of the PR and between aea5b9b and ac66bc9.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (3)
  • projects/site/eleventy.config.js
  • projects/site/package.json
  • projects/site/src/_11ty/transforms/html-minify.js
💤 Files with no reviewable changes (2)
  • projects/site/eleventy.config.js
  • projects/site/package.json

Comment on lines 8 to 13
try {
result = process.env.ELEVENTY_RUN_MODE !== 'watch' ? minifyStyleTags(minifyHTML(content)) : content;
result = process.env.ELEVENTY_RUN_MODE !== 'watch' ? await minifyHTML(content) : content;
} catch (_) {
result = content;
}
return result;

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Silent error swallowing hides minification failures.

The catch (_) discards the error and falls back to unminified content without any diagnostic. In build mode a minification failure would then silently ship larger, unminified HTML with no signal in the build logs. Consider logging the error before falling back.

♻️ Proposed change
   try {
     result = process.env.ELEVENTY_RUN_MODE !== 'watch' ? await minifyHTML(content) : content;
-  } catch (_) {
+  } catch (error) {
+    console.warn('html-minify: minification failed, using unminified content', error);
     result = content;
   }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
try {
result = process.env.ELEVENTY_RUN_MODE !== 'watch' ? minifyStyleTags(minifyHTML(content)) : content;
result = process.env.ELEVENTY_RUN_MODE !== 'watch' ? await minifyHTML(content) : content;
} catch (_) {
result = content;
}
return result;
try {
result = process.env.ELEVENTY_RUN_MODE !== 'watch' ? await minifyHTML(content) : content;
} catch (error) {
console.warn('html-minify: minification failed, using unminified content', error);
result = content;
}
return result;
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@projects/site/src/_11ty/transforms/html-minify.js` around lines 8 - 13, The
html-minify transform is swallowing minification failures without any
diagnostic, so update the try/catch around minifyHTML in the transform function
to log the caught error before falling back to the original content. Keep the
existing fallback behavior for watch/build safety, but make sure the catch path
includes a clear error message and the actual exception details so failures are
visible in build logs.

- fixes issue with style tag minification
- removes direct dependency for css minification

Signed-off-by: Cory Rylan <crylan@nvidia.com>
@coryrylan coryrylan merged commit 0ff44a6 into main Jul 2, 2026
14 checks passed
@coryrylan coryrylan deleted the topic-logo-fixes branch July 2, 2026 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file scope(ci) scope(docs) scope(internals)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants