Skip to content

Update README.md#2253

Merged
chilijung merged 1 commit into
mainfrom
chilijung-patch-1
May 9, 2026
Merged

Update README.md#2253
chilijung merged 1 commit into
mainfrom
chilijung-patch-1

Conversation

@chilijung
Copy link
Copy Markdown
Member

@chilijung chilijung commented May 9, 2026

Summary by CodeRabbit

  • Documentation
    • Enhanced README with a dedicated Documentation section linking to the Wren AI OSS documentation site
    • Reorganized Community resources section for improved navigation

Review Change Stack

@chilijung chilijung merged commit ba187b7 into main May 9, 2026
1 of 3 checks passed
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 9, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 9, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: f5fe6441-2a0f-4fb3-80a4-afce556715f7

📥 Commits

Reviewing files that changed from the base of the PR and between 160c7fb and a2a432a.

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

Walkthrough

README.md is restructured to establish a dedicated Documentation section after Quick start content, consolidating documentation links. The Community section is reordered to present Discord, Discussions, and Issues in a new sequence, with the Docs site reference removed from that section since it now resides in the Documentation section.

Changes

README Documentation Reorganization

Layer / File(s) Summary
Documentation Section
README.md
New Documentation section added after Quick start, linking to Wren AI OSS documentation.
Community Section Restructuring
README.md
Community section items (Discord, Discussions, Issues) reordered; Docs site bullet removed and consolidated into the dedicated Documentation section above.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • Canner/WrenAI#1665: Both PRs modify and reorganize README.md content structure.
  • Canner/WrenAI#1701: Both PRs restructure README.md with updated documentation references and section ordering.

Suggested reviewers

  • wwwy3y3
  • cyyeh

Poem

🐰 A doc hop through the README's garden,
Docs now bloom in their own section bright,
Community gathers in new arrangement,
Each link finds its rightful home tonight! 📚✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chilijung-patch-1

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant