Skip to content

docs: OSS adoption upgrade#1

Merged
solomonneas merged 1 commit into
mainfrom
docs/adoption-upgrade
Jun 26, 2026
Merged

docs: OSS adoption upgrade#1
solomonneas merged 1 commit into
mainfrom
docs/adoption-upgrade

Conversation

@solomonneas

Copy link
Copy Markdown
Collaborator

Brings the README up to the Escoffier/Lidless OSS adoption standard (what/why/how-differs lead, badges, Website link to https://lidless.dev/soc-stack, why-not / what-it-is-not), adds missing maintainer-health files, and aligns repo metadata. Docs-only. No release. No CodeRabbit.

Bring the README and maintainer-health files up to the adoption standard.

README:
- Prominent website link to lidless.dev/soc-stack near the top
- Live CI and release status badges plus the existing tool badges
- Sharpened first paragraph: what / why / how it differs
- New keyword-rich "What it does" section (SOC lab, Proxmox, Wazuh,
  TheHive, Cortex, MISP, Zeek, Suricata, homelab, MCP)
- Redacted result-JSON example block (RFC 5737 documentation IPs)
- "Why not something else?" and "What soc-stack is not" sections
- Local clone quickstart and an honest single-maintainer status note

Health files:
- Add CODE_OF_CONDUCT.md (Contributor Covenant 2.1)
- Add .github/ISSUE_TEMPLATE/config.yml (no blank issues, route security
  and questions off the issue tracker)
- Add a no-PII / no-leak checkbox to the pull request template
- Add an Unreleased CHANGELOG entry for the docs work

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@solomonneas, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 54 minutes and 24 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: be2db885-ca35-453b-858c-55d39cb84646

📥 Commits

Reviewing files that changed from the base of the PR and between 8f3b023 and d3d81ba.

📒 Files selected for processing (5)
  • .github/ISSUE_TEMPLATE/config.yml
  • .github/PULL_REQUEST_TEMPLATE.md
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/adoption-upgrade

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.

@solomonneas solomonneas merged commit 7f7c46d into main Jun 26, 2026
4 of 5 checks passed
@solomonneas solomonneas deleted the docs/adoption-upgrade branch June 26, 2026 15:34
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