MarketSquare / MarketSquare/robotframework-style-guide
Help menu for guide and subject content organization
Nobody has claimed this yet.
- Dominant language
- RobotFramework
- Stars
- 29
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
We should create a consistent top to bottom approach for the content based on scope.
Make it easy to find information- "I am trying to find out about Spacing rules regarding Keywords"
Create a linked help page to those items.
| Subject Matter | | | |
-- | -- | -- | -- | -- | --
Scope | Spacing | Line Continuation | Arguments | Documentation | Vertical Spacing
File | | | | |
Section | | | | |
Suite | | | | |
Test | | | | |
Keyword | | | | |
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
No files, tests, or entry points are named. Start by reviewing the existing guide and subject content, then define the scope-based organization and linked help page described in the issue; done means users can navigate from a subject such as keyword spacing to the relevant guidance.
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
- Needs clarification
- Newbie friendliness
- 25/100