docs: Update README.md #25355
docs: Update README.md #25355
Conversation
Added developer community links
📝 WalkthroughWalkthroughREADME content reorganized and rewritten with new sections, removed badges, updated focus areas, and revised links. Docusaurus site config updated to reference banner.svg instead of banner.jpg. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
README.md (5)
5-5: Nit: Improve banner alt text for accessibility.Use a descriptive alt or empty alt if purely decorative.
- +
31-31: Correct IBC wording: ibc-go is a separate repo/module integrating with the SDK.Current text implies it’s part of this repo. Recommend clarifying.
-Cosmos SDK blockchains get interoperability out-of-the-box via a native integration with the [Inter-Blockchain Communication Protocol (IBC)](https://github.com/cosmos/ibc-go). Ibc-go is implemented as a Go module in the Cosmos SDK. +Cosmos SDK blockchains get interoperability out of the box via [IBC](https://github.com/cosmos/ibc-go). IBC‑Go is a separate repository implemented as a Cosmos SDK module that integrates with SDK‑based chains.Refs: ibc-go lives in its own repo and is “built as a Cosmos SDK module”; the IBC module was removed from the SDK repo starting v0.43. (github.com)
68-70: Fix markdownlint MD034 (bare URL).Use a proper Markdown link.
-**View the Cosmos SDK documentation: https://docs.cosmos.network/** +**View the Cosmos SDK documentation:** [docs.cosmos.network](https://docs.cosmos.network/)
73-73: Avoid unverified “10k+ TPS” claim for CometBFT.Throughput varies by workload, validator set, and config; public, official benchmarks are nuanced. Either remove the numeric claim or add a reputable citation with conditions. (docs.cometbft.com)
-- [CometBFT](https://github.com/cometbft/cometbft) - High-performance, 10k+ TPS configurable BFT consensus engine. +- [CometBFT](https://github.com/cometbft/cometbft) - High‑performance, configurable BFT consensus engine.If you prefer to keep numbers, please add a source specifying environment and limits.
66-66: Unify Discord links (README vs docs).README uses https://discord.com/invite/interchain while docs use https://discord.gg/cosmosnetwork — choose one canonical URL (or label them separately: “Developer” vs “Community”) and make links consistent.
- README.md — lines 19, 66: https://discord.com/invite/interchain
- docs/docusaurus.config.js — lines 148, 161: https://discord.gg/cosmosnetwork
- docs/docs/Introduction.md — line 36: https://discord.gg/cosmosnetwork
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting
⛔ Files ignored due to path filters (2)
docs/static/img/banner.jpgis excluded by!**/*.jpg,!**/*.jpgdocs/static/img/banner.svgis excluded by!**/*.svg,!**/*.svg
📒 Files selected for processing (2)
README.md(2 hunks)docs/docusaurus.config.js(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
69-69: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: repo-analysis
- GitHub Check: build (arm64)
- GitHub Check: build (amd64)
- GitHub Check: markdown-link-check
- GitHub Check: Summary
🔇 Additional comments (1)
README.md (1)
50-54: Confirm rebrand & legal ownership; make naming consistent across the repoSearch found mixed naming: README.md (lines 51, 53) states "Cosmos Labs is a wholly‑owned subsidiary of the Interchain Foundation"; docs/docusaurus.config.js (line 178) and several contrib/* READMEs still reference "Interchain Labs".
- Verify whether Interchain Labs officially rebranded to Cosmos Labs (and the effective date) and confirm whether "wholly‑owned subsidiary" remains legally accurate with the Interchain Foundation.
- If confirmed, update wording for consistency (e.g., "Cosmos Labs (formerly Interchain Labs) …") and replace/clarify occurrences at: README.md (51–53), docs/docusaurus.config.js:178, contrib/x/group/README.md, contrib/x/nft/README.md, contrib/x/circuit/README.md.
| /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ | ||
| ({ | ||
| image: "img/banner.jpg", | ||
| image: "img/banner.svg", |
There was a problem hiding this comment.
🧩 Analysis chain
Fix: themeConfig.image cannot be an SVG (breaks OG/Twitter cards).
Docusaurus explicitly forbids SVGs for themeConfig.image. Use a raster (PNG/JPG, e.g., 1200x630). Otherwise social previews will fail. (docusaurus.io)
Apply:
- image: "img/banner.svg",
+ image: "img/banner.png",Ensure docs/static/img/banner.png exists and matches the hero art.
🏁 Script executed:
#!/bin/bash
# Verify social card asset + repo-wide consistency
set -euo pipefail
echo "Checking Docusaurus meta image usage:"
rg -nP 'themeConfig:\s*\([\s\S]*?image:\s*["\']img/.*\.(svg|png|jpe?g|webp)["\']' docs/docusaurus.config.js -n
echo -e "\nListing banner assets under docs/static/img:"
fd -a -e png -e jpg -e jpeg -e webp -e svg banner docs/static/img || true
echo -e "\nSearching for lingering references to banner.jpg/svg across repo:"
rg -n 'banner\.(svg|jpg|png|jpeg|webp)'Length of output: 99
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "1) Show docs/docusaurus.config.js (up to 400 lines):"
if [ -f docs/docusaurus.config.js ]; then
sed -n '1,400p' docs/docusaurus.config.js || true
else
echo "docs/docusaurus.config.js not found"
fi
echo -e "\n2) Find 'themeConfig' occurrences (context +-3 lines):"
rg -n --hidden -S "themeConfig" -C3 || true
echo -e "\n3) Show lines containing 'image' or 'img/' in docs/docusaurus.config.js:"
if [ -f docs/docusaurus.config.js ]; then
rg -n --hidden -S "image" docs/docusaurus.config.js -C2 || true
rg -n --hidden -S "img/" docs/docusaurus.config.js -C2 || true
fi
echo -e "\n4) List image files under docs/static/img (all common image extensions):"
if [ -d docs/static/img ]; then
fd -a -t f -e svg -e png -e jpg -e jpeg -e webp docs/static/img || true
else
echo "docs/static/img not found"
fi
echo -e "\n5) Search repo for 'banner.' occurrences (case-insensitive):"
rg -n --hidden -i "banner\\." || trueLength of output: 15894
Replace OG image SVG with a raster and add the asset
- Change in docs/docusaurus.config.js:65:
- image: "img/banner.svg",
+ image: "img/banner.png",- Add docs/static/img/banner.png (recommended 1200×630) or update the config to point to an existing PNG/JPG. README.md:5 references docs/static/img/banner.svg — update that reference if you replace/move the asset.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| image: "img/banner.svg", | |
| image: "img/banner.png", |
🤖 Prompt for AI Agents
In docs/docusaurus.config.js around line 65, the OG image currently points to an
SVG (img/banner.svg); replace it with a raster image by adding
docs/static/img/banner.png (recommended 1200×630) and update the config line to
"img/banner.png" or alternatively point the config to an existing PNG/JPG; also
update README.md line 5 which references docs/static/img/banner.svg to the new
PNG path so references stay consistent.
3 participants
Updating the product information and contact information to the latest version.
Closes: #XXXX
Summary by CodeRabbit
Documentation
Style