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

docs(README): add list adapters section #3219

Merged
merged 4 commits into from
Mar 21, 2024

Conversation

czar0
Copy link
Contributor

@czar0 czar0 commented Mar 8, 2024

Closes #3218

Description

A section in the README to explain how to generate a list of all available adapters.

Changes

A bunch of lines in the README (only docs) and one line in .gitignore.

Steps to Test

N/A

Quality Assurance

N/A

Copy link

changeset-bot bot commented Mar 8, 2024

⚠️ No Changeset found

Latest commit: 9ca1671

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@karen-stepanyan
Copy link
Contributor

Hey @czar0 . Thanks for opening the PR. What's the intention of this change ? The MASTERLIST.md is created/updated automatically after every release, so it contains up-to-date information and is available at a root level. Why would anyone want to generate it manually ?

@czar0
Copy link
Contributor Author

czar0 commented Mar 21, 2024

oh, shoot! I wondered whether that script was even called anywhere😄 (apologies). Anyway, this unclarity builds even a stronger case for this simple addition. The intent is to slightly improve the user experience by presenting to the end user a list of available adapters (the culprit MASTERLIST.md).
Put it in a story format: As an end user, I want to have a concise list of available external adapters and their properties so that I can quickly understand their purpose and start using them.
I believe a small addition to the README should be enough (changes just pushed).
Let me know if that makes sense to you.

Copy link
Contributor

@karen-stepanyan karen-stepanyan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that we can include information about Masterlist in the main readme. Suggested a minor change

README.md Outdated Show resolved Hide resolved
@karen-stepanyan karen-stepanyan merged commit e6ba024 into smartcontractkit:main Mar 21, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Section to explain how to generate a list of available adapters in the README
2 participants