ScienceOL Docs

• Project Overview
• Features
• Quick Start
• Documentation
• Community & Support
• Contributing
• License
• Contact

Project Overview

ScienceOL Docs is the official documentation project of the ScienceOL ecosystem, dedicated to providing comprehensive, systematic, and user-friendly product and developer documentation. ScienceOL aims to build a fully open-source, general AI for Science laboratory system, promoting automation, intelligence, and collaboration in scientific research.

Ecosystem:

• Studio: Multi-environment management & community portal
• Protium: AI-native containerized workflow orchestration
• Xyzen: Intelligent agent for laboratory
• Anti: 3D digital twin platform (coming soon)
• LabOS: Hardware laboratory OS

---

Features

• 🧩 Modular: By product line & features
• 🚀 Quick Start: Detailed onboarding & dev guides
• 🛠️ Developer Friendly: Full API, architecture, best practices
• 🌐 Community Driven: PRs welcome, core dev Q&A

---

Quick Start

1. Clone the repository

git clone https://github.com/ScienceOL/docs.git
cd docs

2. Install dependencies

Recommended: Yarn

yarn install

3. Start local development

yarn dev

Docs will be served at http://localhost:32235 by default.

---

Documentation

• English Docs
• See directory structure below:

docs/
├── docker/           # Docker configs
├── launch/           # Launch & build scripts
├── public/           # Static assets
├── src/
│   ├── app/          # Main docs (EN & CN)
│   ├── components/   # Reusable components
│   ├── styles/       # Styles
│   └── ...           # Other
├── README.md         # Project description
├── package.json      # Dependencies & scripts
└── ...               # Other configs

---

Community & Support

• Official Site: https://scienceol.tech
• GitHub Issues: https://github.com/ScienceOL/docs/issues
• Core Team & Advisors: Team Introduction
• Please open an Issue or PR, or contact team members via email

---

Contributing

We welcome all forms of contribution: docs, corrections, suggestions, code PRs, etc.

1. Fork & create a new branch
2. Commit & open a Pull Request
3. Wait for review

See Developer Docs Guide for details.

---

License

This project is licensed under GPL-3.0 License.

---

Contact

• Official Site: https://scienceol.tech
• GitHub Issues: https://github.com/ScienceOL/docs/issues
• Core Team & Advisors: Team Introduction
• Email: Please leave a message in Issues or contact team members via email

---

If you want to further beautify, add badges, logo, or acknowledgements, let me know!