-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
helper domains also added to /etc/hosts in readme for local dev #61
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis update introduces the addition of several local testing domains to the Changes
Poem
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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Outside diff range and nitpick comments (2)
README.md (2)
Line range hint
1-1
: Ensure headings are surrounded by blank lines.Markdown standards recommend that headings be surrounded by blank lines to improve readability and compatibility with various markdown renderers.
+ # DRAFT - Distributed Relay and Automation Facilitation Tool + ... + ## Appendix +Also applies to: 222-222
Tools
Markdownlint
158-158: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
154-154: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
Line range hint
21-21
: Add language specifications to fenced code blocks.For better syntax highlighting and readability, specify the language next to the code fences. This is especially important for commands and code snippets that users will interact with.
- ``` + ```bashAlso applies to: 26-26, 84-84, 89-89, 145-145, 173-173
Tools
Markdownlint
158-158: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
154-154: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
Markdownlint
README.md
9-9: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
43-43: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
51-51: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
67-67: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
76-76: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
95-95: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
96-96: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
105-105: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
110-110: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
118-118: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
220-220: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
221-221: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
1-1: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
222-222: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
10-10: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
222-222: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
21-21: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
26-26: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
84-84: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
89-89: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
145-145: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
173-173: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
20-20: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
27-27: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
47-47: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
53-53: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
100-100: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
204-204: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
205-205: null (MD034, no-bare-urls)
Bare URL used
206-206: null (MD034, no-bare-urls)
Bare URL used
16-16: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
119-119: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
158-158: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
21-21: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
70-70: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
84-84: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
89-89: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
123-123: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
135-135: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
142-142: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
148-148: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
154-154: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
162-162: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
168-168: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
173-173: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
179-179: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
193-193: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
214-214: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
Additional comments not posted (2)
README.md (2)
155-155
: Validate the command for updating/etc/hosts
.The command to update the
/etc/hosts
file is crucial for proper local domain resolution. Ensure that the syntax is correct and the domains are appropriately added. The command usessudo
, which is necessary for modifying the/etc/hosts
file, and it appends multiple entries. It seems well-formed for the stated purpose.
Line range hint
9-9
: Reduce multiple consecutive blank lines.Multiple consecutive blank lines can disrupt the flow and structure of the document. It's best to limit to a single blank line to separate sections clearly.
-
Also applies to: 43-43, 51-51, 67-67, 76-76, 95-95, 96-96, 105-105, 110-110, 118-118, 220-220, 221-221
Tools
Markdownlint
158-158: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
154-154: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
Markdownlint
README.md
9-9: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
43-43: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
51-51: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
67-67: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
76-76: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
95-95: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
96-96: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
105-105: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
110-110: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
118-118: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
220-220: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
221-221: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
1-1: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
222-222: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
10-10: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
222-222: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
21-21: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
26-26: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
84-84: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
89-89: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
145-145: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
173-173: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
20-20: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
27-27: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
47-47: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
53-53: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
100-100: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
204-204: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
205-205: null (MD034, no-bare-urls)
Bare URL used
206-206: null (MD034, no-bare-urls)
Bare URL used
16-16: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
119-119: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
158-158: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
21-21: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
70-70: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
84-84: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
89-89: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
123-123: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
135-135: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
142-142: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
148-148: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
154-154: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
162-162: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
168-168: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
173-173: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
179-179: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
193-193: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
214-214: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
Additional comments not posted (1)
README.md (1)
155-155
: Update to/etc/hosts
file is correct and necessary for local development.The command provided correctly appends the necessary local development domains to the
/etc/hosts
file, ensuring thatnetwork.conf
can resolve these URLs. This change aligns with the PR's objective to support local development environments.
network.conf
usesurl=helper<n>.draft.test
, so these are also needed in/etc/hosts
Summary by CodeRabbit
helper1.draft.test
,helper2.draft.test
, andhelper3.draft.test
) to the/etc/hosts
file for draft testing.