https://github.com/ahwelgemoed/playwright_doc_gen
POC : User facing docs from E2E.
https://github.com/ahwelgemoed/playwright_doc_gen
e2e playwright testing
Last synced: 9 months ago
JSON representation
POC : User facing docs from E2E.
- Host: GitHub
- URL: https://github.com/ahwelgemoed/playwright_doc_gen
- Owner: ahwelgemoed
- Archived: true
- Created: 2023-01-26T20:28:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-17T12:53:44.000Z (almost 3 years ago)
- Last Synced: 2025-07-01T12:53:57.061Z (12 months ago)
- Topics: e2e, playwright, testing
- Language: TypeScript
- Homepage:
- Size: 336 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [Playwright](https://playwright.dev/) Docs Creator
## This script is used to generate the docs from Playwright e2e test
It its a very POC and it is not ready for anything really.
## Philosophy
Its something simple that came up during a conversation with [@Dueen](https://github.com/Dueen) _"what if your e2e tests generated step by step docs so that your user docs are always up to date._
The more I think about this, I dont think it a very good idea, but It can definitely be a good place to start writing docs for End users.
## Tech
All this is is a [custom reporter](https://playwright.dev/docs/test-reporters#custom-reporters) that generates a markdown file with the steps that the test took.
## Example:
See [here](https://github.com/ahwelgemoed/playwright_doc_gen/blob/main/e2e/newPagess.spec.ts) for the test, but in simple words it a test to test how to create a repo on Github.
The test output is [here](https://github.com/ahwelgemoed/playwright_doc_gen/blob/main/output/create_a_new_github_issue.md)
## How to use
- Clone the repo
- Run `npm install`
- Run `npm run test`
### Some Notes
- Ideally the test will have no screenshot, and we inject the screenshot methods and rerun the test ourselves
- ...