Skip to content

1100 update the main readme#1117

Merged
TheBest6337 merged 5 commits intomasterfrom
1100-update-the-main-readme
Feb 5, 2026
Merged

1100 update the main readme#1117
TheBest6337 merged 5 commits intomasterfrom
1100-update-the-main-readme

Conversation

@TheBest6337
Copy link
Member

simplified design, better overview and links to the wiki now.

Copilot AI review requested due to automatic review settings February 4, 2026 15:26
@TheBest6337 TheBest6337 linked an issue Feb 4, 2026 that may be closed by this pull request
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR simplifies the main README by consolidating detailed documentation into the project wiki and creating a cleaner, more navigable structure with direct links to wiki pages for various topics.

Changes:

  • Restructured README with new sections: Documentation, Videos, Repository Structure, Technology Stack, Hardware Examples, QiTech Machines, Contributing, and License
  • Replaced detailed inline documentation with wiki links for Getting Started, Architecture, EtherCAT basics, hardware examples, and API reference
  • Condensed repository structure and technology stack descriptions for better readability
  • Moved detailed machine catalog and development setup instructions to wiki

@TheBest6337 TheBest6337 force-pushed the 1100-update-the-main-readme branch 2 times, most recently from e1eda48 to b6263e9 Compare February 4, 2026 18:36
@TheBest6337 TheBest6337 merged commit 376e4a4 into master Feb 5, 2026
13 checks passed
@TheBest6337 TheBest6337 deleted the 1100-update-the-main-readme branch February 5, 2026 20:39
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.

Update the main readme

3 participants