New documentation
A pull request for this has already been merged.
- #2615 by @nstepien — merged
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- react, typescript
- Domain
- documentation
Research direction
Start by reviewing the remaining unchecked items in README.md and CONTRIBUTING.md, including API documentation, examples, badges, links, performance considerations, and development/testing guidance. Check the referenced issues and the merged pull request #2615 for context. Done means the applicable documentation checklist items are completed and the README and contributor guidance are updated.
Written by the indexing model from the issue text.
Description
- API documentation
- We'll probably write all the API docs in the README.md
- #2615
- #2650
- #3904
- #3933
- #3959
- Examples / demos
- Remove the old docs
- #2653
- #2648
- #2655
- We need to review the examples we have, polish them, and see if they're relevant/pertinent
- Remove the old docs
- Update the
descriptionfield inpackage.json#2644 - https://github.com/adazzle/react-data-grid/community
- Add one or more issue templates
- #2645
- #2649
- Add a pull request template?
- Add one or more issue templates
- README.md
- Review badges
- Review links
- Review installation guide #2646
- Review quick start #2646
- Features list #2642
- List browser / react support #2642
- Performance Considerations
- CONTRIBUTING.md
- How to develop
- How to test
- How to contribute
- Write change logs up to a stable 7.0.0 release
- Dominant language
- TypeScript
- Stars
- 7.7k
- Forks
- 2.2k
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 30
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.
More from Comcast/react-data-grid
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Comcast/react-data-grid#4045 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
Comcast/react-data-grid#4184 ·
-
Comcast/react-data-grid#4120 · 1 comment · 1 assignee ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
Comcast/react-data-grid#4004 · 4 comments ·
-
Pinned Rows API Open
Difficulty 5/5 Over a week Newbie friendliness 35/100
Comcast/react-data-grid#3940 ·
All issues in Comcast/react-data-grid
Similar issues
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Crush Open
Difficulty 1/5 Under an hour Newbie friendliness 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Open
Difficulty 1/5 Under an hour Newbie friendliness 90/100
ElementsProject/cln-application#167 · 1 comment · 1 reaction ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Quantco/pnpm-licenses#17 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100