Skip to content

Doc features add#1394

Open
julien-zgh wants to merge 5 commits intomurex:mainfrom
julien-zgh:doc-features-add
Open

Doc features add#1394
julien-zgh wants to merge 5 commits intomurex:mainfrom
julien-zgh:doc-features-add

Conversation

@julien-zgh
Copy link
Contributor

@julien-zgh julien-zgh commented Jan 23, 2026

Description:

This PR introduces human-readable feature specifications under doc/features/ to document the main TCR scenarios for onboarding, training, and real-life usage.

The goal is to make it easier to explain how TCR works, what users can expect from it, and how it is intended to be used, especially for new users and during coaching or training sessions.

The documentation is written in a Gherkin-like format to remain structured and readable, while staying documentation-first and non-executable for now.
This allows the project to learn from usage before deciding on a more technical solution (e.g. GoDog, literate tests, or living documentation).

No code behavior is changed and no new dependencies are introduced.

Fixes #810

Type of change

Please tick the appropriate option using [x]

  • Bug fix
  • New feature

Checklist:

Please tick the appropriate options using [x]

  • My PR includes tests that cover my code changes.
    Documentation-only change; no executable tests added.
  • Lint and formatter run with no errors
  • All new and old tests are passing

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.

[Experiment]: Behaviour Driven Developement and Living Documentation

1 participant