==============================
StarlingX Test Documentation
==============================

------------
Introduction
------------

This project contains **Automated Test Cases** that validate the **StarlingX product**.  
The test framework provides tools and structured test cases to ensure the stability and reliability of StarlingX components.  

For more information about StarlingX, see the official documentation:  

🔗 `StarlingX Documentation <https://docs.starlingx.io/>`_

----------------------
Repository Structure
----------------------

The **StarlingX Test Repository Structure** provides an overview of key directories and their purpose within the automation framework.

.. toctree::
   :maxdepth: 1

   directory_structure

-------------------
Contribution Guide
-------------------

For full contribution guidelines, including coding standards, pre-commit hooks, and best practices, see:

.. toctree::
   :maxdepth: 1

   contributing

-----
Links
-----

- **Source Code:** `StarlingX Test Repository <https://opendev.org/starlingx/test>`_
- **Code Review:** `Gerrit Code Review <https://review.opendev.org/#/q/project:starlingx/test>`_