-
Notifications
You must be signed in to change notification settings - Fork 154
chore(docs): Tracer docs #274
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
Conversation
Converted to draft until I've worked also on JSDocs for the module, depends on: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good!
Minor: in the code snippets you are not highlighting the important lines of code.
Example: line 6 in the first code snippet of this section:
http://localhost:8000/core/tracer/#patching-aws-sdk-clients
Recap of changes:
Note: There are some placeholder/TODOs in both annotations & docs for the middleware which I'll complement in the appropriate PR. |
Description of your changes
Created documentation for
Tracer
according to current implementation in #107.How to verify this change
Checkout branch locally & run
npm run docs-runLocalDocker
to run docs locally.Related issues, RFCs
#153
PR status
Is this ready for review?: YES
Is it a breaking change?: NO
Checklist
Breaking change checklist
N/A
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.