Skip to content

docs: refresh README landing page#107

Open
lan17 wants to merge 3 commits into
mainfrom
lev/readme-landing-page
Open

docs: refresh README landing page#107
lan17 wants to merge 3 commits into
mainfrom
lev/readme-landing-page

Conversation

@lan17
Copy link
Copy Markdown
Owner

@lan17 lan17 commented May 18, 2026

Summary

  • Reposition the README around HomeSec as a local-first AI security camera system and self-serve control plane.
  • Replace the stale TOC/quickstart-heavy structure with Docker-first setup, UI overview, pipeline architecture, config/security notes, and current integrations.
  • Compress lower-level plugin/development content while keeping links to deeper docs.

Validation

  • git diff --check
  • Custom README anchor/local-link validation script
  • Graphify orientation/impact queries for README, UI/setup, config, and docs references

Notes

  • Docs-only change; no runtime code changed.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.16%. Comparing base (0d677d9) to head (fed8005).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #107   +/-   ##
=======================================
  Coverage   87.16%   87.16%           
=======================================
  Files         151      151           
  Lines       16422    16422           
=======================================
  Hits        14314    14314           
  Misses       2108     2108           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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