starlingx/test
Code Issues Proposed changes
Files
958ff41826921275d09ee9bfc6a8ba70878af2fa
test/doc/source/index.rst
Andrew Vaillancourt 958ff41826 Add basic documentation skeleton 
Introduced a basic documentation skeleton that mirrors the
flat directory structure of starlingx/test, providing a
foundation for future documentation expansion.

Structured documentation layout based on starlingx/test
directories:
- Created placeholder index.rst files for:
  - config/
  - framework/
  - keywords/
  - resources/
  - scripts/
  - testcases/
  - unit_tests/
  - web_pages/
- Ensured modular navigation through toctree references

Repository overview & navigation improvements:
- Added directory_structure.rst to document the current
  repository layout
- Updated index.rst to provide a central entry point for
  navigating documentation
- Ensured logical linking between sections for future
  expansion

Initial content in resources/:
- Unlike other sections, resources/ contains actual
  documentation beyond a placeholder
- Added resources_overview.rst, covering containerized
  applications, test images, and nightly regression configs

Verified with Sphinx live preview (sphinx-autobuild).

No API documentation yet, just a basic high-level skeleton
for the repository's directories.

Change-Id: I5f21199280c4c472cd812021bf0f9c3fa6f5c967
Signed-off-by: Andrew Vaillancourt <andrew.vaillancourt@windriver.com>
2025-02-06 18:38:21 -05:00

944 B
Raw Blame History

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: 🔗 https://docs.starlingx.io/

Repository Structure

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

directory_structure

Links