fix(core): Markdown display of note #15311
Conversation
WalkthroughThe changes involve modifying a section in the README.md file. Specifically, a hint block intended to guide Windows users on using Docker with WSL2 has been changed to a note block. This alteration makes the guidance more prominent and clear, ensuring that users do not overlook important information. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[typographical] ~15-~15: Consider adding a comma here. (PLEASE_COMMA)
Context: ... technical information about the project please make sure to read this [overview](https...
[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: .../docs.docker.com/desktop/) installed. - You have direnv inst...
[style] ~30-~30: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...renv](https://direnv.net/) installed. - You have [Java](https://www.java.com/en/dow...
[grammar] ~92-~92: The verb ‘help’ is used with an infinitive. (ADVISE_VBG)
Context: ...checks We have many lint rules to help having a unify code all over the project. To e...
[typographical] ~98-~98: Consider adding a comma after this introductory phrase. (AS_A_NN_COMMA)
Context: ...on and NX lint builder being slow. As a result you might get a `JavaScript heap out of...
[style] ~98-~98: ‘In the meantime’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)
Context: ... on fixing this for an upcoming update. In the meantime you can do `NODE_OPTIONS=“--max-old-spa...
[misspelling] ~146-~146: This word is normally spelled as one. (EN_COMPOUNDS_ELASTIC_SEARCH)
Context: ...n helpers for our development Postgres, Elastic Search, Redis and X-Road Security Server. To ...
[uncategorized] ~161-~161: “Other things” (plural) doesn’t require “other” to be in plural. (OTHERS)
Context: ...e docker running on theses ports or any others services you will need to stop them in order to ...
[style] ~161-~161: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ers services you will need to stop them in order to run the proxies. {% endhint %} ### Env...
[style] ~166-~166: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_NEED_TO_VB)
Context: ...ariables in purely static projects, you need to do the following: 1. In the index.html...
Additional comments not posted (1)
README.md (1)
32-33: Markdown syntax corrected for note display.The change from a hint block to a note block should resolve the display issue as intended. This is a well-formed markdown syntax for a note, which should render correctly on platforms that support GitHub-flavored markdown.
jhonnyV-V
force-pushed
the
fix/readme-note-display
branch
from
60bba35
to
80dc80a
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (5)
README.md (5)
Line range hint
15-15: Consider adding a comma for clarity.After "project please," a comma would enhance the readability:
- To get more technical information about the project please make sure to read this [overview](https://docs.devland.is/technical-overview/technical-overview). + To get more technical information about the project, please make sure to read this [overview](https://docs.devland.is/technical-overview/technical-overview).Tools
LanguageTool
[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: .../docs.docker.com/desktop/) installed. - You have direnv inst...
[style] ~30-~30: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...renv](https://direnv.net/) installed. - You have [Java](https://www.java.com/en/dow...
[uncategorized] ~33-~33: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...on). > [!NOTE] > If you are running on Windows we recommend using [Docker and WSL2](ht...
Line range hint
92-92: Grammar correction: verb usage with 'help'.The verb 'help' should be followed by an infinitive without 'to', or the gerund form:
- We have many lint rules to help having a unify code all over the project. + We have many lint rules to help maintain a unified codebase throughout the project.Tools
LanguageTool
[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: .../docs.docker.com/desktop/) installed. - You have direnv inst...
[style] ~30-~30: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...renv](https://direnv.net/) installed. - You have [Java](https://www.java.com/en/dow...
[uncategorized] ~33-~33: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...on). > [!NOTE] > If you are running on Windows we recommend using [Docker and WSL2](ht...
Line range hint
98-98: Consider rephrasing for conciseness and clarity.The phrase "In the meantime" can be shortened, and a comma should be added:
- In the meantime you can do `NODE_OPTIONS=“--max-old-space-size=4096” yarn lint <project>` to raise the memory limit. + Meanwhile, you can use `NODE_OPTIONS=“--max-old-space-size=4096” yarn lint <project>` to raise the memory limit.Tools
LanguageTool
[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: .../docs.docker.com/desktop/) installed. - You have direnv inst...
[style] ~30-~30: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...renv](https://direnv.net/) installed. - You have [Java](https://www.java.com/en/dow...
[uncategorized] ~33-~33: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...on). > [!NOTE] > If you are running on Windows we recommend using [Docker and WSL2](ht...
Line range hint
146-146: Correct compound word spelling."Elastic Search" should be spelled as one word:
- Elastic Search + ElasticsearchTools
LanguageTool
[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: .../docs.docker.com/desktop/) installed. - You have direnv inst...
[style] ~30-~30: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...renv](https://direnv.net/) installed. - You have [Java](https://www.java.com/en/dow...
[uncategorized] ~33-~33: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...on). > [!NOTE] > If you are running on Windows we recommend using [Docker and WSL2](ht...
Line range hint
161-161: Grammar and style improvements.Correct the plural form and avoid wordiness:
- If you have docker running on theses ports or any others services you will need to stop them in order to run the proxies. + If you have Docker running on these ports or any other services, you should stop them to run the proxies.Tools
LanguageTool
[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: .../docs.docker.com/desktop/) installed. - You have direnv inst...
[style] ~30-~30: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...renv](https://direnv.net/) installed. - You have [Java](https://www.java.com/en/dow...
[uncategorized] ~33-~33: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...on). > [!NOTE] > If you are running on Windows we recommend using [Docker and WSL2](ht...
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[typographical] ~15-~15: Consider adding a comma here. (PLEASE_COMMA)
Context: ... technical information about the project please make sure to read this [overview](https...
[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: .../docs.docker.com/desktop/) installed. - You have direnv inst...
[style] ~30-~30: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...renv](https://direnv.net/) installed. - You have [Java](https://www.java.com/en/dow...
[uncategorized] ~33-~33: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...on). > [!NOTE] > If you are running on Windows we recommend using [Docker and WSL2](ht...
[grammar] ~92-~92: The verb ‘help’ is used with an infinitive. (ADVISE_VBG)
Context: ...checks We have many lint rules to help having a unify code all over the project. To e...
[typographical] ~98-~98: Consider adding a comma after this introductory phrase. (AS_A_NN_COMMA)
Context: ...on and NX lint builder being slow. As a result you might get a `JavaScript heap out of...
[style] ~98-~98: ‘In the meantime’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)
Context: ... on fixing this for an upcoming update. In the meantime you can do `NODE_OPTIONS=“--max-old-spa...
[misspelling] ~146-~146: This word is normally spelled as one. (EN_COMPOUNDS_ELASTIC_SEARCH)
Context: ...n helpers for our development Postgres, Elastic Search, Redis and X-Road Security Server. To ...
[uncategorized] ~148-~148: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...oad Security Server. To do so, you can run for example: ```bash ./scripts/run-db-...
[uncategorized] ~161-~161: “Other things” (plural) doesn’t require “other” to be in plural. (OTHERS)
Context: ...e docker running on theses ports or any others services you will need to stop them in order to ...
[style] ~161-~161: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ers services you will need to stop them in order to run the proxies. {% endhint %} ### Env...
[style] ~166-~166: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_NEED_TO_VB)
Context: ...ariables in purely static projects, you need to do the following: 1. In the index.html...
Additional comments not posted (1)
README.md (1)
32-33: Ensure proper formatting for markdown note syntax.The markdown syntax for the note seems correct, ensuring it displays properly as intended in the PR description. This change should make the note more visible and functional.
Tools
LanguageTool
[uncategorized] ~33-~33: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...on). > [!NOTE] > If you are running on Windows we recommend using [Docker and WSL2](ht...
saevarma
changed the title
|
Thanks for this. There is a reason as this hint style is from GitBook and once upon a time all readmes in the repo were extracted to GitBook. Now it has been seperated but this syntax not updated, hence the weird rendering in GH. Currently our CI is not being triggered for external contributions so I will admin merge this, feel free to update other hint styles when you encounter them. |
What
Currently, there is a note in the README that is not being display correctly
Why
This would make it easy to see the note and make it work as intended
Screenshots
Checklist:
there is node code changes, so I think I could check all of this
Summary by CodeRabbit