Skip to content

docs: Add lite package page#905

Merged
russellhancox merged 5 commits intomainfrom
rah/docs-lite-pkg
Apr 10, 2026
Merged

docs: Add lite package page#905
russellhancox merged 5 commits intomainfrom
rah/docs-lite-pkg

Conversation

@russellhancox
Copy link
Copy Markdown
Member

No description provided.

@russellhancox russellhancox requested a review from a team as a code owner April 9, 2026 16:57
@github-actions github-actions bot added docs Improvements or additions to documentation size/s Size: small labels Apr 9, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 9, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 950e9e22-0e2f-4b90-92db-af73e33073d1

📥 Commits

Reviewing files that changed from the base of the PR and between 40d556b and 34f4ff1.

📒 Files selected for processing (1)
  • docs/docs/deployment/lite-package.md
✅ Files skipped from review due to trivial changes (1)
  • docs/docs/deployment/lite-package.md

📝 Walkthrough

Walkthrough

Adds a new documentation page describing the "Lite Package" distribution (packaging, intended use, and upgrade/downgrade semantics) and updates the troubleshooting doc's sidebar ordering.

Changes

Cohort / File(s) Summary
Lite Package Documentation
docs/docs/deployment/lite-package.md
New doc introducing the santa-lite-YYYY.X.pkg variant: details removal of Workshop-only components, re-signing/re-notarization process, intended audience, operational guidance for Workshop vs non-Workshop devices, upgrade/downgrade behaviors, and reduced testing coverage for Lite variants.
Documentation Sidebar Positioning
docs/docs/deployment/troubleshooting.md
Frontmatter sidebar_position changed from 11 to 12 to adjust sidebar order.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • Add network extension docs #895 — Related docs addressing the Network Extension/profile and Workshop gating, which overlap the Lite Package's rationale and installation concerns.
🚥 Pre-merge checks | ✅ 1 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive No pull request description was provided by the author, making it impossible to evaluate whether it relates to the changeset. Add a description explaining the purpose and context of the lite package documentation being added to help reviewers understand the change.
✅ Passed checks (1 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: Add lite package page' clearly summarizes the main change—adding documentation for the lite package feature.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch rah/docs-lite-pkg

Warning

Review ran into problems

🔥 Problems

Timed out fetching pipeline failures after 30000ms


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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
docs/docs/deployment/lite-package.md (2)

22-25: Consider documenting how Lite installs are detected.

This section explains removed functionality, but adding one line about the Info.plist marker (SNTIsLite) would make operational/debug behavior clearer and technically precise.

Suggested addition
 Santa includes an optional network extension for adding telemetry of network
 events. While this extension can only be activated by Workshop customers, its
 presence on disk is enough to make a small number of users uncomfortable.
+Lite installations are identified via the app bundle `Info.plist` key
+`SNTIsLite=true`; removal of `sleigh`/`santanetd` is a consequence of that mode.

Based on learnings: In northpolesec/santa (PR #841), Lite installation detection is driven by the SNTIsLite key in the app bundle Info.plist.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/docs/deployment/lite-package.md` around lines 22 - 25, Add a one-line
note in the "Lite package" doc stating how Lite installs are detected: mention
the Info.plist key SNTIsLite in the app bundle is used to mark/detect Lite
installations (reference SNTIsLite and Info.plist in the text near the
removed-functionality paragraph).

24-33: Optional wording cleanup for readability.

Phrases like “a small number of users” and “exact same” are slightly wordy; tightening them would improve scanability.

Optional wording tweak
-events. While this extension can only be activated by Workshop customers, its
-presence on disk is enough to make a small number of users uncomfortable.
+events. While this extension can only be activated by Workshop customers, its
+presence on disk is enough to make some users uncomfortable.
@@
-The lite package is created from the exact same build as the regular package
+The lite package is created from the same build as the regular package
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/docs/deployment/lite-package.md` around lines 24 - 33, Reword the
paragraph under the "What's the downside of the Lite package?" heading to
tighten phrasing: replace "a small number of users" with a more concise phrase
like "some users", change "the exact same build" to "the same build", and
simplify the testing sentence to something like "This package receives less
testing than the full package — we perform regular upgrade testing for the full
release but cannot include the Lite package due to the larger test matrix."
Update the text around signing/notarizing/packaging as needed to keep the same
meaning while improving readability.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/docs/deployment/lite-package.md`:
- Around line 16-19: The sentence "but those components will not enable
themselves without Workshop anyway." starts with a lowercase 'but'—capitalize it
to "But" to fix sentence capitalization in the user-facing guidance; update the
sentence text accordingly and run a quick spell/grammar check on the surrounding
paragraph to ensure punctuation remains correct.

---

Nitpick comments:
In `@docs/docs/deployment/lite-package.md`:
- Around line 22-25: Add a one-line note in the "Lite package" doc stating how
Lite installs are detected: mention the Info.plist key SNTIsLite in the app
bundle is used to mark/detect Lite installations (reference SNTIsLite and
Info.plist in the text near the removed-functionality paragraph).
- Around line 24-33: Reword the paragraph under the "What's the downside of the
Lite package?" heading to tighten phrasing: replace "a small number of users"
with a more concise phrase like "some users", change "the exact same build" to
"the same build", and simplify the testing sentence to something like "This
package receives less testing than the full package — we perform regular upgrade
testing for the full release but cannot include the Lite package due to the
larger test matrix." Update the text around signing/notarizing/packaging as
needed to keep the same meaning while improving readability.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a9c2c300-5886-40f6-be88-d975b839863b

📥 Commits

Reviewing files that changed from the base of the PR and between a16e26b and 816ff03.

📒 Files selected for processing (2)
  • docs/docs/deployment/lite-package.md
  • docs/docs/deployment/troubleshooting.md

Comment thread docs/docs/deployment/lite-package.md Outdated
mlw
mlw previously approved these changes Apr 9, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/docs/deployment/lite-package.md`:
- Line 11: Change the section headings that are currently level 3 (###) to level
2 (##) so the markdown follows proper hierarchy; update the header "Why does the
Lite package exist?" and the other subsection headings in this document (the
similar headings around the occurrences noted) from ### to ## to increment
correctly from the top-level title. Ensure all four affected heading lines use
"##" consistently and leave the rest of the content unchanged.
- Line 20: Update the sentence that reads "The lite package is built from the
same artifacts as the full package, then" to use consistent capitalization by
changing "lite" to "Lite" (i.e., modify the phrase "The lite package..." to "The
Lite package...") so it matches the rest of the document's capitalization.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 947707c7-f631-4dac-833a-c10bf7fbf0ee

📥 Commits

Reviewing files that changed from the base of the PR and between 816ff03 and 40d556b.

📒 Files selected for processing (1)
  • docs/docs/deployment/lite-package.md

Comment thread docs/docs/deployment/lite-package.md Outdated
Comment thread docs/docs/deployment/lite-package.md Outdated
@russellhancox russellhancox merged commit 3fbb96d into main Apr 10, 2026
4 checks passed
@russellhancox russellhancox deleted the rah/docs-lite-pkg branch April 10, 2026 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation size/s Size: small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants