Skip to content

docs(profile): replace star-history-only org page with a real org overview#1

Open
Terastar-Paperclip wants to merge 1 commit into
ESPresense:mainfrom
Terastar-Paperclip:cm-org-profile-readme
Open

docs(profile): replace star-history-only org page with a real org overview#1
Terastar-Paperclip wants to merge 1 commit into
ESPresense:mainfrom
Terastar-Paperclip:cm-org-profile-readme

Conversation

@Terastar-Paperclip
Copy link
Copy Markdown

Summary

The current org profile is a single embedded star-history chart — a first-time visitor sees no description of what ESPresense is, who it serves, or where to start.

This PR replaces it with a one-screen overview:

  • one-paragraph what-it-is (firmware + companion + HA, in plain language)
  • who it'''s for (homeowners / HA users / makers)
  • the four flagship repos with one-line each (firmware, companion, ESPresense.com, Floorplan-Creator)
  • support escalation: GitHub Discussions → Discord → file an issue
  • contributing path: firmware CONTRIBUTING + Discord

Notes

  • Single file change: profile/README.md.
  • All outbound links verified live.
  • Wording aimed at a first-time visitor landing on github.com/ESPresense, not at existing power users — happy to revise tone or trim further.
  • The previous star-history chart was not preserved here so the page stays one screen; if you want it kept, easiest is a small follow-up PR appending it after the contributing section.

Tracking on Paperclip ESPA-11.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 26, 2026

Warning

Rate limit exceeded

@Terastar-Paperclip has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 42 minutes and 28 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 42 minutes and 28 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b54c4b7d-37f2-4c4c-a920-e3a1388d22a8

📥 Commits

Reviewing files that changed from the base of the PR and between eec7ace and 4589fbf.

📒 Files selected for processing (1)
  • profile/README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

@Terastar-Paperclip
Copy link
Copy Markdown
Author

@DTTerastar — review requested when you have a minute. This replaces the bare star-history-only org profile with a one-screen overview (what ESPresense is, who it's for, four flagship repos, support path, contributing). Filed via the Terastar-Paperclip PAT, which is pull-only on this repo — could not set you as a formal reviewer through the API, hence the @-mention. Tracking on Paperclip ESPA-11.

@Terastar-Paperclip
Copy link
Copy Markdown
Author

Can we have BOTH?

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