-
Notifications
You must be signed in to change notification settings - Fork 1
docs: update core README with extended description #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: mint
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,2 +1,105 @@ | ||||||||||||||||||||
| # movement-core | ||||||||||||||||||||
| 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** | ||||||||||||||||||||
|
|
||||||||||||||||||||
| --- | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Overview | ||||||||||||||||||||
|
|
||||||||||||||||||||
| `movement-core` defines the foundational principles, system design, and governance framework for the **Movement Network**, enabling secure and scalable human–AI coordination. This repository serves as the backbone for all core protocols, governance mechanisms, and decision-making logic within the ecosystem. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The project aims to: | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - Establish a **robust architecture** for decentralized coordination between humans and AI. | ||||||||||||||||||||
| - Define **transparent governance models** that ensure accountability, inclusivity, and scalability. | ||||||||||||||||||||
| - Provide **reference implementations** and tools for developers building on the Movement Network. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| --- | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Key Features | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - **Core Principles**: Philosophical and technical guidelines that drive the system’s design and long-term strategy. | ||||||||||||||||||||
| - **Governance Logic**: Smart contract templates and off-chain models for decentralized decision-making and voting. | ||||||||||||||||||||
| - **System Architecture**: Modular and extensible structure for integrating AI coordination and human oversight. | ||||||||||||||||||||
| - **Security & Compliance**: Frameworks and best practices to maintain integrity, auditability, and resilience. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| --- | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Architecture Overview | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The Movement Network is structured around: | ||||||||||||||||||||
|
|
||||||||||||||||||||
| 1. **Core Protocol Layer** | ||||||||||||||||||||
| - Handles fundamental operations, permissioning, and inter-module interactions. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| 2. **Governance & Voting Layer** | ||||||||||||||||||||
| - On-chain and off-chain governance mechanisms, including role-based access, proposal lifecycle, and execution logic. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| 3. **AI Coordination Layer** | ||||||||||||||||||||
| - Interfaces for human–AI interactions, decision augmentation, and automated execution pipelines. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| 4. **Integration Layer** | ||||||||||||||||||||
| - Connectors for third-party applications, tools, and smart contracts to extend ecosystem capabilities. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| --- | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Getting Started | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ### Prerequisites | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - Node.js ≥ 20.x | ||||||||||||||||||||
| - Hardhat or Foundry (for Solidity contracts) | ||||||||||||||||||||
| - Git | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ### Installation | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ```bash | ||||||||||||||||||||
| git clone https://github.com/cshein45/movement-core.git | ||||||||||||||||||||
| cd movement-core | ||||||||||||||||||||
| npm install | ||||||||||||||||||||
| ```` | ||||||||||||||||||||
|
Comment on lines
+56
to
+60
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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 |
||||||||||||||||||||
|
|
||||||||||||||||||||
| ### Running Tests | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ```bash | ||||||||||||||||||||
| npm test | ||||||||||||||||||||
| ``` | ||||||||||||||||||||
|
|
||||||||||||||||||||
| --- | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Contributing | ||||||||||||||||||||
|
|
||||||||||||||||||||
| We welcome contributions from the community! | ||||||||||||||||||||
|
|
||||||||||||||||||||
| 1. Fork the repository. | ||||||||||||||||||||
| 2. Create a feature branch (`git checkout -b feature/my-feature`). | ||||||||||||||||||||
| 3. Commit your changes (`git commit -m "Add my feature"`). | ||||||||||||||||||||
| 4. Push to the branch (`git push origin feature/my-feature`). | ||||||||||||||||||||
| 5. Open a pull request describing your changes. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| Please follow our **code style guidelines** and **commit message format** for consistency. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| --- | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Governance | ||||||||||||||||||||
|
|
||||||||||||||||||||
| Movement Network governance is **transparent, decentralized, and auditable**. Key principles: | ||||||||||||||||||||
|
|
||||||||||||||||||||
| * **Role-based Permissions**: Clear assignment of responsibilities and authority. | ||||||||||||||||||||
| * **Proposal Lifecycle**: Transparent submission, discussion, voting, and execution process. | ||||||||||||||||||||
| * **AI & Human Coordination**: Decisions are augmented by AI insights but validated through human oversight. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| --- | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## License | ||||||||||||||||||||
|
|
||||||||||||||||||||
| This project is licensed under the [Apache License 2.0](LICENSE). | ||||||||||||||||||||
|
|
||||||||||||||||||||
| --- | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Contact & Community | ||||||||||||||||||||
|
|
||||||||||||||||||||
| * Website: [https://movementnetwork.xyz](https://movementnetwork.xyz) | ||||||||||||||||||||
| * Discord / Telegram: Join our community channels for discussions, updates, and support. | ||||||||||||||||||||
|
Comment on lines
+100
to
+103
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||
|
|
||||||||||||||||||||
| --- | ||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
📝 Committable suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
3-3: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents