robotframework / robotframework/robotframework
Support Markdown in suite and test/task documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 11.9k
- Forks
- 2.6k
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 10
Description
Currently suite and test documentation only supports Robot's own custom documentation format. We are planning to add Markdown support to Libdoc in RF 7.5 (#5304) and I believe we should support Markdown also in test and suite documentation. Because Markdown is so ubiquitous, we can also consider making it the default format in the future.
There are some design decisions to be made related to this. I'll cover them in separate comments.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing suite and test documentation handling, then compare it with the planned Markdown support in Libdoc for RF 7.5 (#5304). Resolve the design decisions described in the issue comments, and consider the work complete when Markdown support for both suite and test documentation has an agreed, testable scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation, testing-qa
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100