Docs/readme refresh

[ShuxiangCao]

Summary by CodeRabbit

• Documentation
  • Reworked the README to provide an updated overview of LeeQ’s experiment orchestration and autonomous calibration capabilities.
  • Added architecture and demo visuals, project status, licensing, acknowledgements, and development guidance.
  • Expanded quick-start instructions with Docker and source-install options.
  • Documented supported workflows, notebooks, simulations, agents, and Chronicle features.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 05ff049b-8eb9-440e-bd23-eda4e236daed

📥 Commits

Reviewing files that changed from the base of the PR and between 0b932fe and 6a7eec9.

⛔ Files ignored due to path filters (2)

• docs/assets/leeq-architecture.svg is excluded by !**/*.svg
• docs/assets/leeq-calibration-demo.gif is excluded by !**/*.gif

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

The README was substantially rewritten. It now describes LeeQ capabilities, installation methods, architecture, workflows, development commands, project status, licensing, and acknowledgements.

Changes

README Documentation

Layer / File(s)	Summary
Project overview and capabilities README.md	Added badges, a framework overview, laboratory workflow details, calibration imagery, and sections describing LeeQ capabilities.
Setup and workflow documentation README.md	Added Docker and source-install instructions, architecture details, workflow listings, and notebook references.
Documentation and project resources README.md	Updated documentation and development links, contributing guidance, project status, licensing, and acknowledgements.

Estimated code review effort: 1 (Trivial) | ~5 minutes

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/readme-refresh

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}