Skip to content

docs: unify documentation structure across all reporters#452

Merged
gibiw merged 1 commit intomainfrom
docs/unify-reporter-documentation
Feb 9, 2026
Merged

docs: unify documentation structure across all reporters#452
gibiw merged 1 commit intomainfrom
docs/unify-reporter-documentation

Conversation

@gibiw
Copy link
Contributor

@gibiw gibiw commented Feb 9, 2026

Summary

  • Standardize README structure across all reporters (pytest, behave, robotframework, tavern)
  • Add PyPI version and downloads badges to all READMEs
  • Create comprehensive usage guides in docs/usage.md for each reporter
  • Add new pytest documentation: ATTACHMENTS.md, STEPS.md, PARAMETERS.md
  • Restructure qase-python-commons README as configuration reference
  • Fix status mapping: use invalid instead of blocked for failed (other exception)

Changes

Package Files
qase-pytest README.md, docs/usage.md, docs/ATTACHMENTS.md, docs/STEPS.md, docs/PARAMETERS.md
qase-behave README.md, docs/usage.md
qase-robotframework README.md, docs/usage.md
qase-tavern README.md, docs/usage.md
qase-python-commons README.md

Documentation Structure

All READMEs now follow unified structure:

  1. Title + Badges (version, downloads, license)
  2. Features
  3. Installation
  4. Quick Start
  5. Configuration
  6. Usage
  7. Running Tests
  8. Requirements
  9. Links to detailed docs

Test plan

  • Verify all markdown renders correctly on GitHub
  • Check all internal links work
  • Verify badges display correctly

- Standardize README structure: Features, Installation, Quick Start, Configuration, Usage, Running Tests, Requirements
- Add table of contents for better navigation
- Add PyPI version and downloads badges to all READMEs
- Create detailed usage guides in docs/usage.md for each reporter
- Add new documentation for pytest: ATTACHMENTS.md, STEPS.md, PARAMETERS.md
- Restructure qase-python-commons README as configuration reference
- Link all reporters to qase-python-commons for full configuration options
- Fix status mapping: use 'invalid' instead of 'blocked' for failed (other exception)
@gibiw gibiw merged commit 275c36b into main Feb 9, 2026
71 of 72 checks passed
@gibiw gibiw deleted the docs/unify-reporter-documentation branch February 9, 2026 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments