MarketSquare / MarketSquare/robotframework-style-guide
Format conventions for all pages
Open
Nobody has claimed this yet.
addressed-elsewhere
- Dominant language
- RobotFramework
- Stars
- 29
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
We need a consistent way to format the rules, explanation and examples.
**Constraints**
- Docusaurus
**Goal of this issue**
- Gather possible formats
- Decide on a format
**Out of scope**
- Update all existing pages according the new format.
Contributor guide
No contributing guide indexed for this repository
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 Docusaurus pages and the current presentation of rules, explanations, and examples. Gather possible formatting approaches, discuss and decide on one format, and record the agreed convention; updating existing pages is explicitly out of scope.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100