patternfly / patternfly/patternfly-org
Bug - outdated code examples for v5 docs
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 74
- Forks
- 147
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 2
Description
Describe the problem
Code examples on the v5 documentation page are outdated despite the fact the the page claims to show the state for 5.4.2
It seems all docs are outdated but for me the problem was with Select component. Breaking changes added in https://github.com/patternfly/patternfly-react/pull/11249 are missing . Without those changes the example is no longer working properly (starting from 5.4.11).
Expected behavior
The example code should work properly on the newest version.
Screenshots
Jira Issue: PF-3691
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 with the v5 archive Select component typeahead page linked in the issue and compare its example with the breaking changes in patternfly-react PR 11249. Update the outdated example so it works with the newest version, then verify the rendered documentation example and check whether other v5 examples have the same problem.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100