docs: use fancy notes #485
Conversation
WalkthroughThe recent changes in the 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 (
|
|
Let me know when ready to merge! |
|
I'm ready for this to be merge! |
![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 UI
Review profile: CHILL
Files selected for processing (1)
- README.md (3 hunks)
Additional Context Used
LanguageTool (25)
README.md (25)
Near line 43: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ed the webpacker to shakapacker upgrades and it all seems to be running smoothly! Th...
Near line 43: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...nks again for all your support and your teams work! 😍 > > On top of your work, it wa...
Near line 45: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... > On top of your work, it was now also very easy for me to upgrade Tailwind and include ...
Near line 45: This expression is usually spelled with a hyphen.
Context: ... Tailwind and include our external node_module based web component library which we were usi...
Near line 45: Use ‘will’ instead of ‘going to’ if the following action is certain.
Context: ...r (more modern) apps already. That work is going to be shipped later this week though as we...
Near line 47: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ast bits of it. 😉 > > Have a great 2023 and maybe we get to work together again lat...
Near line 64: This phrase is duplicated. You should probably use “View Helpers” only once.
Context: ...d Code](#configuration-and-code) - View Helpers - [View Helpersjavascript_pack_tagand `stylesheet_p...
Near line 165: Consider using either the past participle “installed” or the present participle “installing” here.
Context: ...the desired package manager is actually install at the right version, which can be done...
Near line 203: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... splitting, fingerprinting, and HMR. 3. Provide a community-supported, default webpack ...
Near line 244: Possible missing comma found.
Context: ...le the content hash for aNODE_ENVof production as that would break the browser caching...
Near line 399: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... View Helper:favicon_pack_tagIf you want to create a favicon: ```erb <%= favicon_pa...
Near line 405: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...iew Helper:preload_pack_assetIf you want to preload a static asset in your<head>...
Near line 412: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...### Images in Stylesheets If you want to use images in your stylesheets:css...
Near line 447: Did you mean: “By default,”?
Context: ...ption inshakapacker.ymlconfig file. By defaultmtimestrategy is used in development...
Near line 455: Possible missing comma found.
Context: ...hed in the browser memory. > > For more details see [issue 88: Caching issues in Develo...
Near line 472: Consider using just “revert”.
Context: ...ct that it's not running and Rails will revert back to on-demand compilation if you have ...
Near line 621: Possible missing preposition found.
Context: ...ader.md). Please note that if you want opt-in to use esbuild-loader, you can skip ...
Near line 766: After the expression ‘for example’ a comma is usually used.
Context: ...tps://vue-loader.vuejs.org/guide/) For example to add Vue support: ```js // config/web...
Near line 800: Consider inserting a comma before ‘however’.
Context: ...nt, test and production environments inconfig/shakapacker.ymlhowever, in most production apps extra environme...
Near line 881: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...(or entry points, as webpack calls it). Therefore you don't want to put any file inside `...
Near line 883: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...p/javascript/controllers. Suppose you want to change the source directory fromapp/j...
Near line 922: Possible missing comma found.
Context: ...these folders will also have their path stripped just like with thesource_path. Exam...
Near line 928: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...:** Please be careful when adding paths here otherwise it will make the compilation slow, cons...
Near line 935: Possible missing comma found.
Context: ...ased toassets:precompile. Similar to sprockets both rake tasks will compile packs in p...
Near line 978: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...rs The following companies support our Open Source projects, and ShakaCode uses their prod...
Markdownlint (172)
README.md (172)
56: Expected: asterisk; Actual: dash
Unordered list style
57: Expected: asterisk; Actual: dash
Unordered list style
58: Expected: asterisk; Actual: dash
Unordered list style
59: Expected: asterisk; Actual: dash
Unordered list style
60: Expected: asterisk; Actual: dash
Unordered list style
61: Expected: asterisk; Actual: dash
Unordered list style
62: Expected: asterisk; Actual: dash
Unordered list style
63: Expected: asterisk; Actual: dash
Unordered list style
64: Expected: asterisk; Actual: dash
Unordered list style
65: Expected: asterisk; Actual: dash
Unordered list style
66: Expected: asterisk; Actual: dash
Unordered list style
67: Expected: asterisk; Actual: dash
Unordered list style
68: Expected: asterisk; Actual: dash
Unordered list style
69: Expected: asterisk; Actual: dash
Unordered list style
70: Expected: asterisk; Actual: dash
Unordered list style
71: Expected: asterisk; Actual: dash
Unordered list style
72: Expected: asterisk; Actual: dash
Unordered list style
73: Expected: asterisk; Actual: dash
Unordered list style
74: Expected: asterisk; Actual: dash
Unordered list style
75: Expected: asterisk; Actual: dash
Unordered list style
76: Expected: asterisk; Actual: dash
Unordered list style
77: Expected: asterisk; Actual: dash
Unordered list style
78: Expected: asterisk; Actual: dash
Unordered list style
79: Expected: asterisk; Actual: dash
Unordered list style
80: Expected: asterisk; Actual: dash
Unordered list style
81: Expected: asterisk; Actual: dash
Unordered list style
82: Expected: asterisk; Actual: dash
Unordered list style
83: Expected: asterisk; Actual: dash
Unordered list style
84: Expected: asterisk; Actual: dash
Unordered list style
85: Expected: asterisk; Actual: dash
Unordered list style
86: Expected: asterisk; Actual: dash
Unordered list style
87: Expected: asterisk; Actual: dash
Unordered list style
88: Expected: asterisk; Actual: dash
Unordered list style
89: Expected: asterisk; Actual: dash
Unordered list style
90: Expected: asterisk; Actual: dash
Unordered list style
91: Expected: asterisk; Actual: dash
Unordered list style
92: Expected: asterisk; Actual: dash
Unordered list style
93: Expected: asterisk; Actual: dash
Unordered list style
94: Expected: asterisk; Actual: dash
Unordered list style
95: Expected: asterisk; Actual: dash
Unordered list style
96: Expected: asterisk; Actual: dash
Unordered list style
97: Expected: asterisk; Actual: dash
Unordered list style
98: Expected: asterisk; Actual: dash
Unordered list style
99: Expected: asterisk; Actual: dash
Unordered list style
100: Expected: asterisk; Actual: dash
Unordered list style
106: Expected: asterisk; Actual: dash
Unordered list style
107: Expected: asterisk; Actual: dash
Unordered list style
108: Expected: asterisk; Actual: dash
Unordered list style
111: Expected: asterisk; Actual: dash
Unordered list style
112: Expected: asterisk; Actual: dash
Unordered list style
113: Expected: asterisk; Actual: dash
Unordered list style
114: Expected: asterisk; Actual: dash
Unordered list style
115: Expected: asterisk; Actual: dash
Unordered list style
116: Expected: asterisk; Actual: dash
Unordered list style
117: Expected: asterisk; Actual: dash
Unordered list style
118: Expected: asterisk; Actual: dash
Unordered list style
119: Expected: asterisk; Actual: dash
Unordered list style
120: Expected: asterisk; Actual: dash
Unordered list style
124: Expected: asterisk; Actual: dash
Unordered list style
125: Expected: asterisk; Actual: dash
Unordered list style
126: Expected: asterisk; Actual: dash
Unordered list style
127: Expected: asterisk; Actual: dash
Unordered list style
180: Expected: asterisk; Actual: dash
Unordered list style
181: Expected: asterisk; Actual: dash
Unordered list style
182: Expected: asterisk; Actual: dash
Unordered list style
183: Expected: asterisk; Actual: dash
Unordered list style
184: Expected: asterisk; Actual: dash
Unordered list style
185: Expected: asterisk; Actual: dash
Unordered list style
186: Expected: asterisk; Actual: dash
Unordered list style
187: Expected: asterisk; Actual: dash
Unordered list style
188: Expected: asterisk; Actual: dash
Unordered list style
189: Expected: asterisk; Actual: dash
Unordered list style
190: Expected: asterisk; Actual: dash
Unordered list style
191: Expected: asterisk; Actual: dash
Unordered list style
192: Expected: asterisk; Actual: dash
Unordered list style
440: Expected: asterisk; Actual: dash
Unordered list style
441: Expected: asterisk; Actual: dash
Unordered list style
100: Expected: 2; Actual: 0
Inconsistent indentation for list items at the same level
56: Expected: 0; Actual: 2
Unordered list indentation
57: Expected: 0; Actual: 2
Unordered list indentation
58: Expected: 2; Actual: 4
Unordered list indentation
59: Expected: 0; Actual: 2
Unordered list indentation
60: Expected: 2; Actual: 4
Unordered list indentation
61: Expected: 0; Actual: 2
Unordered list indentation
62: Expected: 0; Actual: 2
Unordered list indentation
63: Expected: 2; Actual: 4
Unordered list indentation
64: Expected: 2; Actual: 4
Unordered list indentation
65: Expected: 4; Actual: 6
Unordered list indentation
66: Expected: 4; Actual: 6
Unordered list indentation
67: Expected: 4; Actual: 6
Unordered list indentation
68: Expected: 4; Actual: 6
Unordered list indentation
69: Expected: 4; Actual: 6
Unordered list indentation
70: Expected: 4; Actual: 6
Unordered list indentation
71: Expected: 2; Actual: 4
Unordered list indentation
72: Expected: 2; Actual: 4
Unordered list indentation
73: Expected: 2; Actual: 4
Unordered list indentation
74: Expected: 4; Actual: 6
Unordered list indentation
75: Expected: 4; Actual: 6
Unordered list indentation
76: Expected: 4; Actual: 6
Unordered list indentation
77: Expected: 2; Actual: 4
Unordered list indentation
78: Expected: 2; Actual: 4
Unordered list indentation
79: Expected: 2; Actual: 4
Unordered list indentation
80: Expected: 2; Actual: 4
Unordered list indentation
81: Expected: 2; Actual: 4
Unordered list indentation
82: Expected: 4; Actual: 6
Unordered list indentation
83: Expected: 4; Actual: 6
Unordered list indentation
84: Expected: 4; Actual: 6
Unordered list indentation
85: Expected: 4; Actual: 6
Unordered list indentation
86: Expected: 4; Actual: 6
Unordered list indentation
87: Expected: 4; Actual: 6
Unordered list indentation
88: Expected: 4; Actual: 6
Unordered list indentation
89: Expected: 4; Actual: 6
Unordered list indentation
90: Expected: 4; Actual: 6
Unordered list indentation
91: Expected: 2; Actual: 4
Unordered list indentation
92: Expected: 2; Actual: 4
Unordered list indentation
93: Expected: 2; Actual: 4
Unordered list indentation
94: Expected: 2; Actual: 4
Unordered list indentation
95: Expected: 0; Actual: 2
Unordered list indentation
96: Expected: 0; Actual: 2
Unordered list indentation
97: Expected: 0; Actual: 2
Unordered list indentation
98: Expected: 0; Actual: 2
Unordered list indentation
99: Expected: 0; Actual: 2
Unordered list indentation
124: Expected: 0; Actual: 1
Unordered list indentation
125: Expected: 0; Actual: 1
Unordered list indentation
126: Expected: 0; Actual: 1
Unordered list indentation
127: Expected: 0; Actual: 1
Unordered list indentation
32: Expected: 0 or 2; Actual: 1
Trailing spaces
175: Expected: 0 or 2; Actual: 1
Trailing spaces
290: Expected: 0 or 2; Actual: 1
Trailing spaces
503: Expected: 0 or 2; Actual: 1
Trailing spaces
410: Expected: 1; Actual: 2
Multiple consecutive blank lines
496: Expected: 1; Actual: 2
Multiple consecutive blank lines
610: Expected: 1; Actual: 2
Multiple consecutive blank lines
932: Expected: 1; Actual: 2
Multiple consecutive blank lines
963: Expected: 1; Actual: 2
Multiple consecutive blank lines
30: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
110: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
122: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
250: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
398: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
404: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
411: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
725: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
730: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
735: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
960: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
134: null
Fenced code blocks should be surrounded by blank lines
214: null
Fenced code blocks should be surrounded by blank lines
278: null
Fenced code blocks should be surrounded by blank lines
316: null
Fenced code blocks should be surrounded by blank lines
322: null
Fenced code blocks should be surrounded by blank lines
328: null
Fenced code blocks should be surrounded by blank lines
360: null
Fenced code blocks should be surrounded by blank lines
365: null
Fenced code blocks should be surrounded by blank lines
370: null
Fenced code blocks should be surrounded by blank lines
386: null
Fenced code blocks should be surrounded by blank lines
393: null
Fenced code blocks should be surrounded by blank lines
400: null
Fenced code blocks should be surrounded by blank lines
406: null
Fenced code blocks should be surrounded by blank lines
607: null
Fenced code blocks should be surrounded by blank lines
711: null
Fenced code blocks should be surrounded by blank lines
726: null
Fenced code blocks should be surrounded by blank lines
731: null
Fenced code blocks should be surrounded by blank lines
736: null
Fenced code blocks should be surrounded by blank lines
767: null
Fenced code blocks should be surrounded by blank lines
111: null
Lists should be surrounded by blank lines
124: null
Lists should be surrounded by blank lines
961: null
Lists should be surrounded by blank lines
608: null
Bare URL used
226: null
Fenced code blocks should have a language specified
278: null
Fenced code blocks should have a language specified
941: null
Fenced code blocks should have a language specified
Additional comments not posted (3)
README.md (3)
159-159: Update note formatting to enhance visual appeal and standardization.This change aligns with the PR's objective to make the documentation more visually appealing by standardizing the note format across the document.
172-172: Ensure consistency in note formatting across the document.This change is part of the effort to standardize the presentation of notes within the README, making the documentation cleaner and more professional.
449-455: Clarify caching behavior in development environments.This addition provides valuable information on how caching behaves when not using
shakapacker-dev-server, which is crucial for understanding potential issues in development environments.
Summary
Let's be fancy ✨
Pull Request checklist
Add/update test to cover these changesUpdate CHANGELOG fileOther Information
Summary by CodeRabbit