Skip to content

docs: Improve README with TOC, quick start, and fixes#42

Merged
thibauult merged 2 commits into
mainfrom
docs/improve-readme
Feb 5, 2026
Merged

docs: Improve README with TOC, quick start, and fixes#42
thibauult merged 2 commits into
mainfrom
docs/improve-readme

Conversation

@thibauult

@thibauult thibauult commented Feb 4, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Collaborator

Summary

This PR improves the README documentation with better structure and fixes several issues.

Changes

New Sections

  • Table of Contents - For easier navigation
  • Quick Start - Immediate curl/code generation examples
  • Supported Resources - Lists all API resources covered by the spec

Fixes

  • Fixed typo: 2Run → 2. Run (line 85)
  • Fixed incorrect fork URL: openhue/open-hue → openhue/openhue-api

Improvements

  • Added API Docs badge linking to Redocly
  • Updated callout messaging (removed outdated 'just taken off' phrasing)
  • Expanded Prerequisites section to include Git and Make
  • Added link to CONTRIBUTING.md in the Fork section

Summary by CodeRabbit

  • Documentation
    • Added API Docs badge and a new Table of Contents (Intro, Quick Start, Usage, Getting Started, License, Acknowledgments)
    • Added Quick Start with commands to fetch the OpenAPI spec and generate a client
    • Expanded Introduction with Supported Resources
    • Added validate, build, and docs generation steps (via Make targets) and clarified outputs
    • Improved prerequisites, fork/contributing guidance, setup steps, and minor formatting fixes

@thibauult
docs: Improve README with TOC, quick start, and fixes
e3ab2b9 
- Add API Docs badge linking to Redocly
- Update callout messaging (remove 'just taken off')
- Add Table of Contents for easier navigation
- Add Supported Resources section listing API coverage
- Add Quick Start section with curl and code generation examples
- Fix typo: '2Run' -> '2. Run'
- Fix incorrect fork URL (open-hue -> openhue-api)
- Expand Prerequisites section (add Git, Make)
- Add link to CONTRIBUTING.md in Fork section
@coderabbitai

coderabbitai Bot commented Feb 4, 2026 •
edited
Loading

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

README.md updated: added API Docs badge, Table of Contents, Quick Start (OpenAPI fetch + client generation), Supported Resources list, clarified prerequisites (Git, Make), corrected fork URL, added validate/build/docs make targets and expanded Getting Started steps; minor formatting fixes.

Changes

Cohort / File(s) Summary
Documentation Restructuring
README.md		 Added API Docs badge and Table of Contents; new "Quick Start" with commands to fetch the OpenAPI spec and generate a client; added "Supported Resources" list; clarified Prerequisites (Git, Make); corrected fork reference (open-hue → openhue-api); added make verify, make build (outputs build/openhue.yaml), and make docs (outputs build/index.html); fixed formatting (e.g., 2Run → 2. Run).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I nibbled the README, found crumbs of delight,
I stitched up the headings and set tabs to right,
With make and a badge and a spec to adorn,
The docs hop along on a bright-fledged morn,
Come fetch, build, and read — the rabbit says "onward!" 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically summarizes the main changes: README improvements including a Table of Contents, Quick Start section, and bug fixes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/improve-readme

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.

@thibauult
docs: Add missing resources to Supported Resources section
fe7571a 
Add: bell_button, relative_rotary, camera_motion, grouped_motion,
grouped_light_level, convenience_area_motion, security_area_motion,
motion_area_candidate, motion_area_configuration, device_software_update,
service_group, zigbee_device_discovery, speaker
@thibauult thibauult merged commit aae8201 into main Feb 5, 2026
4 checks passed
@thibauult thibauult deleted the docs/improve-readme branch February 5, 2026 09:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@thibauult