patternfly / patternfly/patternfly-org
Need ability to see what the props inherit from.
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 74
- Forks
- 147
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 2
Description
With more consumers using the documentation framework, we need the ability to see if props extend an existing props. Currently this is not supported. PF extensions can not see what props are missing if the extend props as shown here. In the example above trying to include the props for EmpyState from react-core currently does not work.
Suggested solution is to add this ability to the md file, and allow it link back to the PF component documentation that it's extending.
Jira Issue: PF-601
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 documentation framework's md-file handling and the ErrorState.tsx example linked in the issue, then inspect the existing PatternFly component documentation for props. Define how inherited props should be displayed and linked back to the extending component's documentation. Done means an extension can show the inherited props and provide the requested documentation link.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100