doc: follow common readme guidelines #58
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gagbo
force-pushed
the
doc/readme
branch
12 times, most recently
from
3f576a8
to
a462414
Compare
Shadowing constants in function bindings should be a compilation error (and is, in Rust), but it's not here. Also changing the names of constants to add extra words and type suffix to hopefully avoid conflicts later.
mellowagain
approved these changes
Jul 24, 2023
README.md
Outdated
| [](https://discord.gg/kHtwcH8As9) | ||
|
|
||
| Metrics are a powerful and cost-efficient tool for understanding the health and | ||
| performance of your code in production. But it's hard to decide what metrics to |
There was a problem hiding this comment.
Suggested change
| performance of your code in production. But it's hard to decide what metrics to | |
| performance of your code in production, but it's hard to decide what metrics to |
README.md
Outdated
|
|
||
| See [autometrics.dev](https://docs.autometrics.dev/) for more details on the ideas behind autometrics. | ||
|
|
||
| **Table of Contents** |
There was a problem hiding this comment.
toc is integrated in the github ui already
README.md
Outdated
|
|
||
| There is a one-time setup phase to prime the code for autometrics. Once this | ||
| phase is accomplished, only calling `go generate` is necessary. | ||
|
|
||
| ### Install the go generator. | ||
| #### 1. Install the go generator. |
There was a problem hiding this comment.
i wouldnt go from # to ####, maybe do like # to ### (it looks weird in the toc generated by gh, see comment above)
README.md
Outdated
| ```patch | ||
| +//autometrics:inst | ||
| -func AddUser(args interface{}) error { | ||
| +func AddUser(args interface{}) (err error) { |
There was a problem hiding this comment.
go 1.18 renamed interface{} to any, we should prefer that instead of relying on the alias: https://stackoverflow.com/a/71964388/11494565
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
README glow up.
Checklist
The CHANGELOG is updated.The open-telemetry example in repository works fine:the docker compose file is validthe application compiles and runalerts are getting triggered in PrometheusThe prometheus example in repository works fine:the docker compose file is validthe application compiles and runalerts are getting triggered in Prometheusexemplars are accessible on the graph