Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Overhaul #46

Merged
merged 3 commits into from
Nov 6, 2024
Merged

Documentation Overhaul #46

merged 3 commits into from
Nov 6, 2024

Conversation

noomorph
Copy link
Collaborator

@noomorph noomorph commented Jul 12, 2024

Documentation Site Map

1. Introduction

  • What is jest-allure2-reporter?
  • Why another Allure reporter for Jest?
  • Key advantages over other reporters
  • Installation
    • Prerequisites
    • Setup
  • Usage

2. Core Concepts

  • Anatomy of Reports
  • Report Widgets
    • Environment Information
    • Executors
  • Test Sources
    • Test Cases
    • Test Files
    • Test Run

3. Test Metadata

  • Descriptions
  • Statuses
  • Attachments
  • Ownership
  • Severity Levels
  • Links
  • Test Parameters
  • Custom Labels

4. Test Steps

  • Creating Steps
  • Step Statuses
  • Step Attachments
  • Step Parameters

5. Test Grouping

  • Suites
  • Behaviors
  • Packages
  • Categories

6. Advanced Features

  • Timeline
  • Test History
  • Presets
  • Plugins
  • Jest Internals

7. Customization Approaches

  • Docblock Annotations
  • Runtime API
  • DSL Annotations
  • Declarative Configuration

8. API Reference

  • Exports
  • Docblocks
  • Annotations
  • Decorators
  • Runtime API
  • Plugin API
    • Runtime
    • Source Code

9. Configuration

  • Overview
  • Presets
  • Customizers
  • Helpers
  • Environment
  • Executor
  • Test Case
  • Test Step
  • Test File
  • Test Run

10. Contributing

  • How to Contribute
  • Code of Conduct
  • Development Setup
  • Testing
  • Documentation Guidelines

@noomorph noomorph merged commit 281c26b into beta Nov 6, 2024
3 checks passed
@noomorph noomorph deleted the docs/overhaul branch November 6, 2024 08:39
Copy link
Contributor

github-actions bot commented Nov 6, 2024

🎉 This PR is included in version 2.0.0-beta.26 🎉

The release is available on:

Your semantic-release bot 📦🚀

Copy link
Contributor

github-actions bot commented Nov 6, 2024

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant