README tweaks#488
Conversation
martincostello
commented
May 19, 2025
martincostello
commented
- Reduce need to suppress long lines using different link syntax.
- Add missing Node.js references.
- Use code fences for code terms.
- Note that architecture diagram is internal-only.
- Reduce need to suppress long lines using different link syntax. - Add missing Node.js references. - Use code fences for code terms. - Note that architecture diagram is internal-only.
martincostello
added
the
documentation
- Make markdownlint and EditorConfig rules consistent. - Re-fix EditorConfig warnings. - Remove obsolete settings key.
Make prettier happy too.
Try to make prettier happy again.
|
Not being familiar with mise (or Java), I'm not sure why the JDK install is failing. It was fine on Friday when the last renovate PR was merged. |
me neither - I'm currently investigating |
| ``` | ||
|
|
||
| <!-- editorconfig-checker-disable --> | ||
| <!-- markdownlint-disable MD013 --> |
| An OpenTelemetry backend in a Docker image. | ||
|
|
||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-disable-next-line MD013 --> |
There was a problem hiding this comment.
why do we need annotations for prettier, markdownlint and editorconfig-checker now?
There was a problem hiding this comment.
I added the markdownlint one to remove the squiggles I get in VS Code, but then prettier complains that there isn't a new line between the markdownlint-disable-next-line, but adding that would make the next-line not work, so it needs disabling around that block.
If there's a neater way to make all three happy for this one line I can change it (or I can just make the alt text short enough to not go over 120).
There was a problem hiding this comment.
maybe we can let only one linter check the line length by telling the others to ignore the rule
There was a problem hiding this comment.
I've added a .prettierignore to ignore Markdown sotwo of the extra lines can be removed. For the sake of just the one inline suppression I reckon that's good enough.
Three markdown linters looks like carelessness.
2 participants
