AbsaOSS / AbsaOSS/living-doc-generator-mdoc
SPIKE: Research what is needed to change to introduce regime - guide
- Lingua principale
- Python
- Stelle
- 3
- Fork
- 0
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
## Background
New regime is needed to provide feature of generation guide.
The example: User guide.
Understanding role of E2E tests and User Stories in Living Documentation is required.
## Desired Outcome
- List of changes needed in codebase.
- Definition of changes in E2E tests
- Recording slow videos.
- Creation of screesshots
- Identification of outputs from E2E tests.
- Backup of inputs for later usage.
- Define of pipeline.
- Define User Guide template
- Define the logic for merging template and E2E test outputs to final documents.
```[tasklist]
### Tasks
- [ ] TBD
```
## Additional Info/Resources [Optional]
1. [Miro Living Documentation map](https://miro.com/app/board/uXjVPnnAlY0=/?moveToWidget=3458764617586064136&cot=14) - see the path for Generation of User Guide
2. [From Documented Issue to User Guide diagram](https://miro.com/app/board/uXjVPnnAlY0=/?moveToWidget=3458764617437350371&cot=14)
Guida per i contributori
Apri la guida per i contributori
Valutazione
Questa issue non è ancora stata valutata.