Skip to content

docs(project): complete public installation guidance - #19

Open
LMLiam wants to merge 2 commits into
feat/issue-6-self-contained-dmgfrom
docs/issue-7-public-installation-guidance
Open

docs(project): complete public installation guidance#19
LMLiam wants to merge 2 commits into
feat/issue-6-self-contained-dmgfrom
docs/issue-7-public-installation-guidance

Conversation

@LMLiam

@LMLiam LMLiam commented Jul 29, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add separate Homebrew and DMG installation instructions.
  • Document commands, timers, Control Centre, recovery, and removal.
  • Expand the existing contribution, support, security, and privilege policies.
  • Add repository-wide Markdown lint configuration.

Issues

Closes #7.

This PR is stacked on #18 because the documentation describes the packaged companion.

Behaviour and security

This PR does not change runtime behaviour. The documentation defines the exact privileged paths, file modes, helper commands, battery-only pmset boundary, ad-hoc signing, checksum check, and private vulnerability process.

The installation guide states that the first public release and formula are not available. Later release issues will remove this notice only after publication works.

Verification

  • scripts/check.sh
  • npx --yes markdownlint-cli2 '**/*.md' '#.build'
  • npx --yes markdown-link-check --quiet <document> for each new or changed public guide
  • git diff --check
  • Manual CI run 30494421333

Screenshots

Not applicable.

Checklist

  • scripts/check.sh passes.
  • User and contributor documentation matches the change.
  • Documentation uses ASD-STE100 Simplified Technical English.
  • Every commit uses verb(area): description.
  • Privileged behaviour is covered by safe tests rather than live system mutation.

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 4ad181aa-08f1-42a9-af87-9c7feedb1801

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

@LMLiam

LMLiam commented Jul 29, 2026

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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