Skip to content

docs: improve README formatting and add support sections#597

Merged
gkorland merged 4 commits intostagingfrom
readme-formatting-improvements
Mar 10, 2026
Merged

docs: improve README formatting and add support sections#597
gkorland merged 4 commits intostagingfrom
readme-formatting-improvements

Conversation

@gkorland
Copy link
Contributor

@gkorland gkorland commented Mar 10, 2026

Summary

  • Cherry-picked formatting improvements from Update README.md #472 (which is now outdated after the backend merge)
  • Centered header with professional layout and value proposition tagline
  • Added environment variables reference table
  • Added Contributing, License, and Support sections
  • Fixed GitHub Issues link (was pointing to GraphRAG-SDK)

Context

PR #472 proposed a full README rewrite, but was created before the code-graph-backend merge and its setup instructions are no longer accurate. This PR extracts only the formatting and structural improvements that are still valuable.

Test plan

  • Verify README renders correctly on GitHub

Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com

Summary by CodeRabbit

Documentation

  • Enhanced header with improved tagline, centered layout, Discord badge, and product showcase image
  • Added new Project Structure section with detailed codebase overview
  • Introduced environment variables configuration table with default values for setup reference
  • Reorganized documentation with new Support section including GitHub Issues, Discord, Documentation links, and email contact

@vercel
Copy link

vercel bot commented Mar 10, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
code-graph Error Error Mar 10, 2026 10:48am

Request Review

@gkorland gkorland mentioned this pull request Mar 10, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 10, 2026

Warning

Rate limit exceeded

@gkorland has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 23 minutes and 16 seconds before requesting another review.

⌛ 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: e39b400f-b590-4068-8e92-ae9d8a7e922e

📥 Commits

Reviewing files that changed from the base of the PR and between 8d3bf7d and 63cb8dc.

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

Walkthrough

The README.md was restructured with an enhanced header featuring a new tagline, Discord badge, and product GIF. Environment variable configuration table was added. Community section was renamed to License, and a new Support section was introduced with relevant links.

Changes

Cohort / File(s) Summary
Documentation & Header
README.md
Enhanced header with new tagline, Discord badge, and product GIF. Added environment variable table documenting OPENAI_API_KEY, SECRET_TOKEN, FALKORDB_HOST, and FALKORDB_PORT with default values. Restructured sections: renamed Community to License, added new Support section with GitHub Issues, Discord, Documentation links, and contact email. Added horizontal rule and centered star prompt at end. Minor formatting adjustments throughout.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hop, hop, the docs now shine so bright,
With badges and gifs, what a lovely sight!
Structured with care, variables in place,
Discord and support links embrace the space! ⭐

🚥 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 summarizes the main change: improving README formatting and adding support sections, which aligns with the core objectives of the PR.
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 readme-formatting-improvements

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.

Cherry-picked from #472:
- Centered header with professional layout
- Environment variables reference table
- Contributing, License, and Support sections

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gkorland gkorland force-pushed the readme-formatting-improvements branch from 3fee29b to db06ab7 Compare March 10, 2026 10:42
@gkorland gkorland changed the base branch from main to staging March 10, 2026 10:42
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gkorland gkorland merged commit b1948ca into staging Mar 10, 2026
9 of 10 checks passed
@gkorland gkorland deleted the readme-formatting-improvements branch March 10, 2026 10:48
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