Improve documentation for RouterLayout
Nobody has claimed this yet.
- Dominant language
- AsciiDoc
- Stars
- 38
- Forks
- 225
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 170
Description
The documentation on RouterLayout should include instructions on how to determine where the child view should be shown. Now, all examples are empty Divs. https://vaadin.com/docs/latest/routing/layout#routerlayout-interface
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 with the RouterLayout interface section at https://vaadin.com/docs/latest/routing/layout#routerlayout-interface and review its current examples, especially the empty Div examples. Update the documentation to explain how to determine where a child view should be shown, with a representative example; done means the placement guidance is clear and the examples are no longer empty.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100