Welcome to the Oniro Project documentation repository. This repository hosts the documentation for the Oniro Project, an Eclipse Foundation initiative dedicated to developing an open-source, vendor-neutral Operating System (OS) platform. Oniro builds upon OpenHarmony, extending its capabilities to provide a versatile platform for smart devices across various industries.

This documentation is powered by MkDocs and uses the Material for MkDocs theme. It is hosted on GitHub Pages and follows a structured approach to provide clear and accessible guidance for Oniro developers.

The latest version of the Oniro Project documentation is available at: docs.oniroproject.org.

To build and preview the documentation on your local machine(We use Windows system here), ensure that Python 3.12(or higher version) and pip are installed, then follow these steps:

1. Clone this repository:

   git clone https://github.com/eclipse-oniro4openharmony/eclipse-oniro4openharmony.github.io.git
   cd oniro-docs

2. Install virtual environment:

   python -m venv venv

3. Activate virtual environment:

   .\venv\Scripts\activate

4. Install mkdocs-material:

   pip install mkdocs-material

5. Build and serve the documentation:

   mkdocs serve

6. Open http://localhost:8000/mkdocs/ in your web browser to view the documentation.

This repository is configured to use GitHub Actions for building and deploying documentation. To publish updates:

1. Push changes to the main branch.
2. GitHub Actions will automatically build and deploy the documentation to GitHub Pages.

This documentation is based on the Material for MkDocs theme, which provides a minimal yet functional interface. The theme and its features are documented in the MkDocs Material repository.

We welcome contributions to improve this documentation. If you would like to contribute:

1. Fork this repository.
2. Create a feature branch.
3. Submit a pull request with your changes.

For more details, refer to our contribution guidelines.

This repository is licensed under the CC BY 4.0 License.

For more details about the Oniro Project, visit the Eclipse Oniro website.