This repository was archived by the owner on Aug 31, 2023. It is now read-only.
docs(rome_diagnostics): Move Writing Diagnostics to the top #3551
Conversation
This file contains hidden or 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
and fix a link to the technical philosophy. The main motivation behind moving the writing to the top is because I want to link from it from the blog post but it being at the bottom means the browser can't scroll to the top of the section. The second reason is that it's probably good to know what a diagnostic should be before learning all the technical jargon and details.
✅ Deploy Preview for rometools canceled.
|
MichaReiser
commented
Nov 2, 2022
| Rome as frictionless as possible even when errors happen. What follows is a | ||
| list of best practice for writing good diagnostics: | ||
|
|
||
| - The Diagnostic should follow the (Technical Principles)[https://rome.tools/#technical] |
There was a problem hiding this comment.
Fix the technical principles link. Everything else remains unchanged.
ematipico
reviewed
Nov 2, 2022
ematipico
approved these changes
Nov 2, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
and fix a link to the technical philosophy.
The main motivation behind moving the writing to the top is that I want to link from it from the blog post but it being at the bottom means the browser can't scroll to the top of the section.
The second reason is that it's probably good to know what a diagnostic should be before learning all the technical jargon and details.