docs(metrics): update metrics.md
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.6k
- Forks
- 546
- Avg merge
- 8h 18m
- Merged PRs (30d)
- 16
Description
2023-09-25 JS Colo discussion around js-libp2p metrics: https://pl-strflt.notion.site/js-libp2p-metrics-monitoring-Cayman-e9191e5d022d476db979f91da1e66f3d?pvs=4
- [ ] Create stock dashboards and export and then linked from https://github.com/libp2p/js-libp2p/blob/master/doc/METRICS.md
- [ ] Extracting the API docs out form module index file and put it in the README
- [ ] JS_CONTRIBUTING.md expectation of putting module overview index file, update JS_CONTRIBUTING PR
```[tasklist]
### Tasks
```
Contributor guide
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 with the linked js-libp2p metrics discussion and doc/METRICS.md, then review the module index README and JS_CONTRIBUTING.md references. Done means stock dashboards are exported and linked, API docs are extracted into the README, and the module overview expectation is reflected in JS_CONTRIBUTING.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100