Remove Readme from adaptor docs
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 23
- Forks
- 20
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 6
Description
The README section of the adaptors docs is, by and large, no longer useful.
Since moving to the monorepo the readmes are pretty terse. The only valuable stuff is the contribution and source links, and why not just expose those more clearly for each adaptor?
Usage guides and tutorials and stuff which the readmes may contain would be better presented in the overview, examples, or even their own section.
Instead of the readme, we should add a Contributing & Feedback. This would be boiler-plate for each adaptor with links to the monorepo, basic a check out instructions, github issues etc.
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 adaptor documentation and its README sections, then compare the overview and examples areas. Remove the broadly unhelpful README presentation and ensure each adaptor has a consistent “Contributing & Feedback” section with monorepo, checkout, and GitHub issue links; move useful guides or tutorials into appropriate documentation sections.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100