pnp / pnp/sp-dev-fx-controls-react
Revise documentation
Open
Nobody has claimed this yet.
area:documentation
type:enhancement
- Dominant language
- TypeScript
- Stars
- 433
- Forks
- 418
- Avg merge
- 5d 6m
- Merged PRs (30d)
- 19
Description
Category
[x] Enhancement
Version
Please specify what version of the library you are using: [1.18.0]
We need to go through the documentation to check:
- if there are any missing parts (missing properties, interfaces, etc.)
- provide more code examples where needed, especially for controls that can have alternative set of options for different behavior
- any other problems that may lead to difficulties in adoption of the controls
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 repository's documentation alongside the available controls and their public interfaces. Record missing properties or interfaces, identify controls that need alternative-option examples, and note adoption barriers. Done means the documentation gaps are addressed and the added examples cover the requested behaviors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100