Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Readme from adaptor docs #502

Open
josephjclark opened this issue Jun 19, 2024 · 0 comments
Open

Remove Readme from adaptor docs #502

josephjclark opened this issue Jun 19, 2024 · 0 comments

Comments

@josephjclark
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant