docs: update core README with extended description #1
Conversation
- Clarifies Movement Core scope - Adds extended description for contributors and reviewers - No contract or logic changes
WalkthroughREADME.md was completely rewritten from a minimal single-line header and description to a comprehensive structured documentation document. New sections include Overview, Key Features, Architecture, Getting Started, Contributing, Governance, License, and Contact information with detailed explanatory content throughout. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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: 3
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
3-3: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (1)
README.md (1)
1-105: Well-structured and comprehensive documentation update.The expanded README effectively communicates the project's scope, architecture, and contribution process. The organization is clear and the content is informative for both users and contributors. Once the markdown syntax and link issues are resolved, this will serve as excellent project documentation.
| Foundational architecture and governance logic for the Movement Network. This repository defines core principles, system design, and long-term governance models for human–AI coordination. | ||
| # Movement Core | ||
|
|
||
| **Foundational architecture and governance logic for the Movement Network** |
There was a problem hiding this comment.
Use a heading instead of bold emphasis for the subtitle.
The subtitle on line 3 uses bold emphasis (**...**) but should follow markdown best practices by using a heading level (e.g., ##).
Apply this diff to fix the markdown style violation:
-**Foundational architecture and governance logic for the Movement Network**
+## Foundational architecture and governance logic for the Movement Network📝 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.
| **Foundational architecture and governance logic for the Movement Network** | |
| ## Foundational architecture and governance logic for the Movement Network |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
3-3: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents
In README.md around line 3, the subtitle is using bold markdown (**...**)
instead of a heading; replace the bolded subtitle with an appropriate Markdown
heading (for example prefix the line with "## ") so the subtitle becomes a
level-2 heading and remove the surrounding ** markers.
| ```bash | ||
| git clone https://github.com/cshein45/movement-core.git | ||
| cd movement-core | ||
| npm install | ||
| ```` |
There was a problem hiding this comment.
Fix markdown code block fence syntax.
The opening and closing fences for the code block must use the same number of backticks. Line 56 opens with 3 backticks but line 60 closes with 4 backticks.
Apply this diff to fix the syntax error:
```bash
git clone https://github.com/cshein45/movement-core.git
cd movement-core
npm install
-````
+```🤖 Prompt for AI Agents
In README.md around lines 56 to 60, the Markdown code block opens with three
backticks but closes with four; change the closing fence from four backticks to
three so both fences match (replace the closing "````" with "```"), ensuring the
code block renders correctly.
| ## Contact & Community | ||
|
|
||
| * Website: [https://movementnetwork.xyz](https://movementnetwork.xyz) | ||
| * Discord / Telegram: Join our community channels for discussions, updates, and support. |
There was a problem hiding this comment.
Provide actual links for community channels.
Line 103 references Discord and Telegram but provides no actual URLs. Include functional links to enable users to join the community.
Apply this diff to add functional links:
## Contact & Community
* Website: [https://movementnetwork.xyz](https://movementnetwork.xyz)
-* Discord / Telegram: Join our community channels for discussions, updates, and support.
+* Discord: [https://discord.gg/your-discord-link](https://discord.gg/your-discord-link)
+* Telegram: [https://t.me/your-telegram-link](https://t.me/your-telegram-link)📝 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.
| ## Contact & Community | |
| * Website: [https://movementnetwork.xyz](https://movementnetwork.xyz) | |
| * Discord / Telegram: Join our community channels for discussions, updates, and support. | |
| ## Contact & Community | |
| * Website: [https://movementnetwork.xyz](https://movementnetwork.xyz) | |
| * Discord: [https://discord.gg/your-discord-link](https://discord.gg/your-discord-link) | |
| * Telegram: [https://t.me/your-telegram-link](https://t.me/your-telegram-link) |
🤖 Prompt for AI Agents
README.md around lines 100-103: the "Discord / Telegram" line lacks actual URLs;
replace that line with two separate bullets that include the project's real
invite links (one Discord invite URL and one Telegram group/channel URL)
formatted as clickable Markdown links (e.g., "Discord:
https://discord.gg/your-invite" and "Telegram: https://t.me/your-channel") so
users can join directly; ensure you use the project's correct invite links and
update the link text accordingly.
cshein45
left a comment
cshein45
left a comment
There was a problem hiding this comment.
Overall looks good.
The README update improves clarity around Movement Core’s scope and intent, especially for new contributors and external reviewers. The extended description helps frame the project narrative without touching any contract logic or sensitive implementation details.
No blocking issues from a documentation or governance perspective.
Safe to merge once CI checks pass.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.