Skip to content

[codex] Add GitHub browsing entry points - #1

Open
ChrisBeWithYou wants to merge 2 commits into
mainfrom
codex/github-readme-navigation
Open

[codex] Add GitHub browsing entry points#1
ChrisBeWithYou wants to merge 2 commits into
mainfrom
codex/github-readme-navigation

Conversation

@ChrisBeWithYou

@ChrisBeWithYou ChrisBeWithYou commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Rework the root README as a GitHub-native landing page for the user guide repo
  • Add SUMMARY.md as a complete GitHub-browsable table of contents
  • Add SUPPORT.md with fast support links for Discord/issues/release notes
  • Add CONTRIBUTING.md with repo-specific writing and PR guidance

Notes

This intentionally does not change the rendered docs homepage at docs/index.md. The published site remains unchanged unless org owners approve the README/root repo landing-page direction.

Validation

  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Expanded the user guide with a clear landing page, improved navigation, and a full table of contents.
    • Added contributor guidance with writing rules, local preview steps, and a pull request checklist.
    • Added a dedicated support page with quick links for common issues, troubleshooting tips, and diagnostic reporting.

@ChrisBeWithYou
ChrisBeWithYou marked this pull request as ready for review July 5, 2026 21:32
@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@ChrisBeWithYou, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 36 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

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 reviews.

How do review 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 refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ba5acf08-6704-43d0-928a-2c93354a0df5

📥 Commits

Reviewing files that changed from the base of the PR and between c88d512 and 2b930aa.

📒 Files selected for processing (2)
  • README.md
  • SUPPORT.md
📝 Walkthrough

Walkthrough

This PR adds foundational documentation files for the FeedBack User Guide repository: a new CONTRIBUTING.md guide, an expanded README.md landing page, a new SUMMARY.md table of contents, and a new SUPPORT.md troubleshooting page. All changes are documentation-only.

Changes

Documentation Structure

Layer / File(s) Summary
README landing page
README.md
Replaces placeholder text with Start Here, Support Shortcuts, and Browse By Section navigation, plus refreshed Content Status and Editing Notes bullets.
Navigation table of contents
SUMMARY.md
Adds a complete table of contents linking to documentation sections from Start Here through Contributing.
Support page
SUPPORT.md
Introduces a Fast Support Links table, a What To Ask For checklist, and diagnostics export instructions.
Contribution guide
CONTRIBUTING.md
Adds starting points, writing rules, local MkDocs preview commands, and a pull request checklist.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Related Issues: None specified.

Related PRs: None specified.

Suggested labels: documentation

Suggested reviewers: None specified.


🐰 A guide is born, page by page,
README, SUPPORT, each new stage,
SUMMARY charts the winding way,
CONTRIBUTING shows how to play,
Docs hop forward, cage by cage! 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding GitHub browsing entry points for the user guide.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/github-readme-navigation

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.

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

🧹 Nitpick comments (1)
README.md (1)

25-35: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Surface the new support hub.

The landing page only points readers at troubleshooting pages, so the new SUPPORT.md workflow is easy to miss. Add a direct link here so the diagnostics/checklist path is reachable from the README.

♻️ Proposed fix
 ## Support Shortcuts
+- [Support](SUPPORT.md)
 - [Audio Input Problems](docs/troubleshooting/audio-input.md)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 25 - 35, The README support shortcuts list only links
to troubleshooting docs, so add a direct entry for the new SUPPORT.md workflow
here. Update the support section in README.md to include a clearly labeled link
to SUPPORT.md alongside the existing troubleshooting links so readers can reach
the diagnostics/checklist path from the landing page.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@SUPPORT.md`:
- Line 3: The intro in SUPPORT.md is broader than the page content, since it
mentions Discord and release notes even though the page only covers
troubleshooting, checklist, and diagnostics. Update the opening sentence to
match the actual sections on the page, or add the missing Discord and
release-note guidance if that scope is intended. Use the existing intro line in
SUPPORT.md as the place to tighten the wording.

---

Nitpick comments:
In `@README.md`:
- Around line 25-35: The README support shortcuts list only links to
troubleshooting docs, so add a direct entry for the new SUPPORT.md workflow
here. Update the support section in README.md to include a clearly labeled link
to SUPPORT.md alongside the existing troubleshooting links so readers can reach
the diagnostics/checklist path from the landing page.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ecce3913-b91e-4dde-96e5-d6d9ad25a367

📥 Commits

Reviewing files that changed from the base of the PR and between ac4fd62 and c88d512.

📒 Files selected for processing (4)
  • CONTRIBUTING.md
  • README.md
  • SUMMARY.md
  • SUPPORT.md

Comment thread SUPPORT.md Outdated
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