-
Notifications
You must be signed in to change notification settings - Fork 157
docs: minor improvements #1021
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: minor improvements #1021
Conversation
…on command, reduce font size
📊 Package size report 2%↑
🤖 This report was automatically generated by pkg-size-action |
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.
@@ -67,7 +67,6 @@ You can instrument your code with Powertools in three different ways: | |||
| **POWERTOOLS_TRACER_CAPTURE_HTTPS_REQUESTS** | Captures HTTP(s) requests as segments. | [Tracer](./core/tracer) | `true` | | |||
| **POWERTOOLS_LOGGER_LOG_EVENT** | Logs incoming event | [Logger](./core/logger) | `false` | | |||
| **POWERTOOLS_LOGGER_SAMPLE_RATE** | Debug log sampling | [Logger](./core/logger) | `0` | | |||
| **POWERTOOLS_LOGGER_LOG_EVENT** | Logs incoming events | [Logger](./core/logger) | `false` | |
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.
Redundant
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.
LGTM!
📊 Package size report 2%↑
🤖 This report was automatically generated by pkg-size-action |
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.
Not part of this PR. But should we consider having a dedicated README for each utility?
Copying the same README to every packages makes me feel uncomfortable. I'd prefer to simply put a link the official doc for the package so that we have only a single source of documents. The README at this level should be specific to contribution/development.
@ijemmy completely agree and thanks for bringing this up. |
* docs: consistency with blog post messaging, added one-line installation command, reduce font size * docs: add middy link, add ToC items for CTAs
Description of your changes
Changes introduced:
How to verify this change
Docs: npm run docs-runLocalDocker
Related issues, RFCs
N/A
PR status
Is this ready for review?: YES
Is it a breaking change?: NO
Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.