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

Maintenance: review API docs & README for Metrics #2375

Closed
1 of 5 tasks
dreamorosi opened this issue Apr 16, 2024 · 2 comments · Fixed by #2983
Closed
1 of 5 tasks

Maintenance: review API docs & README for Metrics #2375

dreamorosi opened this issue Apr 16, 2024 · 2 comments · Fixed by #2983
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) metrics This item relates to the Metrics Utility

Comments

@dreamorosi
Copy link
Contributor

dreamorosi commented Apr 16, 2024

Summary

This issue is part of a larger group: #2381

As part of this task we should:

  • review that the README file for the package is relevant for customers and follow the structure described in the parent issue
  • review the API docs and apply the conventions described in the parent issue
  • consider adding a "Testing your code section" to the docs and remove MD043 from docs

Why is this needed?

So that customers finding the package on npm or using the API docs have the right level of details.

Which area does this relate to?

Other

Solution

No response

Acknowledgment

Future readers

Please react with 👍 and your use case to help us understand customer demand.

@dreamorosi dreamorosi added documentation Improvements or additions to documentation metrics This item relates to the Metrics Utility internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) confirmed The scope is clear, ready for implementation labels Apr 16, 2024
@dreamorosi dreamorosi self-assigned this Jul 9, 2024
@am29d am29d self-assigned this Aug 26, 2024
@dreamorosi dreamorosi removed their assignment Aug 27, 2024
Copy link
Contributor

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot added pending-release This item has been merged and will be released soon and removed confirmed The scope is clear, ready for implementation labels Aug 27, 2024
Copy link
Contributor

This is now released under v2.8.0 version!

@github-actions github-actions bot added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon labels Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) metrics This item relates to the Metrics Utility
Projects
Development

Successfully merging a pull request may close this issue.

2 participants