Skip to content

Conversation

@tenthirtyam
Copy link
Collaborator

Summary

Post-tranfer update of README.md

Type

  • fix: Bug Fix
  • feat: Feature or Enhancement
  • docs: Documentation
  • refactor: Refactoring
  • chore: Build, Dependencies, Workflows, etc.
  • other: Other (Please describe.)

Breaking Changes?

  • Yes, there are breaking changes.
  • No, there are no breaking changes.

Tests

  • Tests have been added or updated.
  • Tests have been completed.

Output:

Documentation

  • Documentation has been added or updated.

Issue References

Release Note

Additional Information

@tenthirtyam tenthirtyam added this to the v2.1.0 milestone Jan 29, 2026
@tenthirtyam tenthirtyam self-assigned this Jan 29, 2026
Copilot AI review requested due to automatic review settings January 29, 2026 15:11
@tenthirtyam tenthirtyam added the chore Chore label Jan 29, 2026
@github-actions github-actions bot added documentation Documentation needs-review Needs Review size/l Relative Sizing: Large labels Jan 29, 2026
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates repository README content post-transfer by refreshing introductory wording and reworking documentation sections/links across root and docs readmes.

Changes:

  • Simplifies/rewrites plugin description and “Components” summaries in documentation readmes.
  • Updates root README.md sections (Contributing/Support/License) and documentation links.
  • Adds Broadcom copyright/license header comment to the root README.md.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 12 comments.

File Description
README.md Updates top-level project messaging, contribution/support/license sections, and external documentation URLs.
docs/README.md Simplifies documentation portal README and adjusts component listings.
.web-docs/README.md Mirrors the docs/README.md updates for the web-docs site entry README.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@tenthirtyam tenthirtyam force-pushed the chore(xfer)/update-readme branch 2 times, most recently from 1f528a8 to bfa3d56 Compare January 29, 2026 16:07
Post-tranfer update of `README.md`

Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
@tenthirtyam tenthirtyam force-pushed the chore(xfer)/update-readme branch from bfa3d56 to 1502a86 Compare January 29, 2026 16:08
@tenthirtyam tenthirtyam merged commit 5c04d0b into main Jan 29, 2026
13 checks passed
@tenthirtyam tenthirtyam deleted the chore(xfer)/update-readme branch January 29, 2026 16:10
@tenthirtyam tenthirtyam removed the needs-review Needs Review label Jan 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Chore documentation Documentation size/l Relative Sizing: Large

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants