Skip to content

Add story structure documentation and parallel execution examples#6447

Draft
Copilot wants to merge 3 commits intomasterfrom
copilot/improve-documentation-examples
Draft

Add story structure documentation and parallel execution examples#6447
Copilot wants to merge 3 commits intomasterfrom
copilot/improve-documentation-examples

Conversation

Copy link
Contributor

Copilot AI commented Feb 17, 2026

  • New "Story Structure" documentation page (docs/modules/ROOT/pages/story-structure.adoc) covering:
    • Basic story file structure (Description, Meta, Scenario, steps)
    • GivenStories (story-level and scenario-level with filtering/parameterization)
    • ExamplesTable usage at story and scenario levels
    • Lifecycle steps reference
    • Complete story example
  • Updated navigation (docs/modules/ROOT/nav.adoc) to include the new page
  • Documentation linting passes (spotlessDocumentationCheck)
Original prompt

This section details on the original issue you should resolve

<issue_title>Improve VIVIDUS documentation</issue_title>
<issue_description>Hi Dear VIVIDUS team,

As a novice VIVIDUS user, I would like to see more examples of VIVIDUS features in the documentation

  • description of the story structure: given stories, example tables, etc
  • story-level multithreading configuration and examples

Thanks</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: valfirst <5081226+valfirst@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve VIVIDUS documentation with additional examples Add story structure documentation and parallel execution examples Feb 17, 2026
Copilot AI requested a review from valfirst February 17, 2026 11:45
Copy link
Collaborator

@valfirst valfirst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

split this PR into 2 separate ones: one for story structure documentation, another one for parallel execution examples

Co-authored-by: valfirst <5081226+valfirst@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 17, 2026

split this PR into 2 separate ones: one for story structure documentation, another one for parallel execution examples

Reverted the tests-configuration.adoc changes in 6181251. This PR now only contains the story structure documentation. The parallel execution examples can go in a separate PR.

@valfirst
Copy link
Collaborator

split this PR into 2 separate ones: one for story structure documentation, another one for parallel execution examples

Reverted the tests-configuration.adoc changes in 6181251. This PR now only contains the story structure documentation. The parallel execution examples can go in a separate PR.

@copilot move the parallel execution examples in a separate PR.

Copy link
Contributor Author

Copilot AI commented Feb 17, 2026

split this PR into 2 separate ones: one for story structure documentation, another one for parallel execution examples

Reverted the tests-configuration.adoc changes in [6181251](https://g...

I'm unable to create new PRs — I can only make changes within this existing PR branch. Could you or another contributor open a separate PR for the parallel execution examples? The content that was reverted in 6181251 (the tests-configuration.adoc changes adding the "Parallel Story Execution" subsection) can be used as a starting point.

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.

Improve VIVIDUS documentation

2 participants

Comments