docs

Documentation Directory

Structure

docs/
├── README.md                    # This file
└── tricentis_api_docs/          # Tricentis API documentation (gitignored)
    ├── *.htm                    # HTML documentation files
    └── *_files/                 # Resource directories (CSS, JS, images)

Tricentis API Documentation

The tricentis_api_docs/ directory contains downloaded HTML documentation from Tricentis TOSCA Commander REST API.

Note: This directory is gitignored because:

• Contains third-party documentation
• Large binary assets (images, CSS, JS)
• Can be re-downloaded if needed
• Not part of our source code

Files in tricentis_api_docs/

• prerequisites.htm - REST API prerequisites
• requests.htm - General requests documentation
• opening_workspaces.htm - Opening workspaces
• fetching_object_representations.htm - Object representations
• projectid.htm - ProjectId of workspaces
• *_files/ - Supporting resources (CSS, JavaScript, images)

Source

Original documentation from:

https://documentation.tricentis.com/devcorner/2024.2/tcrsapi/

Re-downloading

If you need the documentation:

1. Visit the official site:

   https://documentation.tricentis.com/devcorner/2024.2/tcrsapi/
   

2. Or create a placeholder:

   mkdir -p docs/tricentis_api_docs
   echo "Download from https://documentation.tricentis.com/devcorner/2024.2/tcrsapi/" > docs/tricentis_api_docs/README.txt

Project Documentation

Main documentation files are in the root directory:

• README.md - Main documentation (English)
• WPROWADZENIE.md - Introduction (Polish)
• QUICKSTART.md - Quick start guide
• API_REFERENCE.md - Complete API reference
• BEST_PRACTICES.md - Best practices
• COMPATIBILITY.md - Compatibility guide
• ARCHITECTURE.md - Architecture overview
• HTTP_CLIENTS.md - HTTP clients documentation
• CHANGELOG.md - Change log
• PROJECT_SUMMARY.md - Project summary
• FILES_OVERVIEW.md - Files overview

Why Separate Directory?

1. Clean root directory - Keep project root organized
2. Easy to ignore - Single gitignore entry
3. Clear separation - Our docs vs. third-party docs
4. Version control - Don't version third-party content