Skip to content

docs: define Support bundle terminology - #607

Merged
frankieramirez merged 1 commit into
mainfrom
frankieramirez/gulper
Aug 10, 2026
Merged

docs: define Support bundle terminology#607
frankieramirez merged 1 commit into
mainfrom
frankieramirez/gulper

Conversation

@frankieramirez

@frankieramirez frankieramirez commented Aug 10, 2026

Copy link
Copy Markdown
Owner

Summary

  • define the canonical user-facing term Support bundle in the domain glossary
  • record that CarePackage is a legacy implementation name only
  • preserve the disclosure boundary established by the completed specification work

Why

The completed Support bundle Wayfinder map established terminology and operator-review requirements that contributors need available in the repository before implementation begins. This focused documentation change records that domain definition without implementing or advertising the feature.

Supports the implementation handoff in #590.

Impact

Documentation only. There is no runtime or user-interface behavior change.

Validation

  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Added guidance describing Support bundles as downloadable archives of approved diagnostic data for public issue attachments.
    • Recommended private sharing when bundles contain sensitive information.
    • Documented CarePackage as the legacy name for Support bundles.

@changeset-bot

changeset-bot Bot commented Aug 10, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: d3e3b61

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 783b3ccc-bdf5-41e0-a0a4-2ee3248d4348

📥 Commits

Reviewing files that changed from the base of the PR and between c158184 and d3e3b61.

📒 Files selected for processing (1)
  • CONTEXT.md

Disabled knowledge base sources:

  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.


📝 Walkthrough

Walkthrough

The documentation defines Support bundles as downloadable archives of allowlisted diagnostic data. It documents operator review, private sharing for sensitive contents, and the legacy CarePackage name.

Changes

Support bundle documentation

Layer / File(s) Summary
Support bundle definition
CONTEXT.md
Defines the Support bundle contents, review requirement, private-sharing guidance, and legacy CarePackage terminology.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Poem

A rabbit reviewed the bundle with care,
Diagnostic notes tucked safely there.
Allowlisted clues, checked before flight,
Private sharing keeps secrets right.
“CarePackage” rests as the name of old—
Hop, hop, the new docs unfold!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch frankieramirez/gulper

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@frankieramirez
frankieramirez marked this pull request as ready for review August 10, 2026 01:22
@frankieramirez
frankieramirez merged commit d132c73 into main Aug 10, 2026
12 of 13 checks passed
@frankieramirez
frankieramirez deleted the frankieramirez/gulper branch August 10, 2026 01:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant