Skip to content

docs(parameters): refresh README for utility with usage examples #1547

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

Merged
merged 2 commits into from
Jun 23, 2023

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This PR introduces changes to the README file of the Parameters utility to refresh its content and include informations relevant to the package, rather than general info about Powertools.

The advantage of doing this is that customers finding the package on npmjs.com can quickly get info on how to use common features of the package, as well as finding links to the docs for more in-depth explanations.

Related issues, RFCs

Issue number: #1532

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi requested a review from a team June 22, 2023 16:23
@dreamorosi dreamorosi linked an issue Jun 22, 2023 that may be closed by this pull request
1 task
@dreamorosi dreamorosi self-assigned this Jun 22, 2023
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jun 22, 2023
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Jun 22, 2023
@dreamorosi
Copy link
Contributor Author

Merging so we can release, the content in this readme are extracts from the utility docs.

If we want to make changes we can do them ahead of GA before the next release.

@dreamorosi dreamorosi merged commit 21013f5 into main Jun 23, 2023
@dreamorosi dreamorosi deleted the 1532-docs-update-parameters-readme branch June 23, 2023 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/L PRs between 100-499 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: update Parameters README
1 participant