Connections Examples #1552
Connections Examples #1552
Conversation
WalkthroughThe documentation for connections has been updated to include new sections that enhance guidance on managing connections. A section titled "Example Internal Configurations" has been added, providing practical JSON examples for hiding connections, moving them in the dropdown list, and theming. Additionally, a section on "Disabling Wsh for a Connection" details how to edit the Changes
Possibly related PRs
Poem
🪧 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration 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: 3
🧹 Nitpick comments (3)
docs/docs/connections.mdx (3)
81-81: Improve grammar in introductory textFor formal documentation, use "a couple of" instead of "a couple".
-Here are a couple examples of things you can do using the internal configuration file `config.json`: +Here are a couple of examples of things you can do using the internal configuration file `config.json`:🧰 Tools
🪛 LanguageTool
[grammar] ~81-~81: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...mple Interal Configurations Here are a couple examples of things you can do using the internal...(PLENTY_OF_NOUNS)
113-113: Add missing comma in compound sentenceFor better readability and correct grammar, add a comma before "but" in the compound sentence.
-Suppose you have a connection named `myhost` that shows up as `myusername@myhost` in the connections dropdown. You use this connection a lot but you keep getting it mixed up with your local connections. +Suppose you have a connection named `myhost` that shows up as `myusername@myhost` in the connections dropdown. You use this connection a lot, but you keep getting it mixed up with your local connections.🧰 Tools
🪛 LanguageTool
[uncategorized] ~113-~113: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... dropdown. You use this connection a lot but you keep getting it mixed up with your ...(COMMA_COMPOUND_SENTENCE)
81-82: Add information about config.json locationConsider adding information about where to find and how to edit the
config.jsonfile. This would help users better understand how to implement these examples.🧰 Tools
🪛 LanguageTool
[grammar] ~81-~81: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...mple Interal Configurations Here are a couple examples of things you can do using the internal...(PLENTY_OF_NOUNS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/docs/connections.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/connections.mdx
[grammar] ~81-~81: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...mple Interal Configurations Here are a couple examples of things you can do using the internal...
(PLENTY_OF_NOUNS)
[uncategorized] ~113-~113: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... dropdown. You use this connection a lot but you keep getting it mixed up with your ...
(COMMA_COMPOUND_SENTENCE)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/docs/connections.mdx (2)
81-81: Improve grammar in the introductionFor formal documentation, consider adding "of" after "couple".
-Here are a couple examples of things you can do using the internal configuration file `connections.json`: +Here are a couple of examples of things you can do using the internal configuration file `connections.json`:🧰 Tools
🪛 LanguageTool
[grammar] ~81-~81: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...ple Internal Configurations Here are a couple examples of things you can do using the internal...(PLENTY_OF_NOUNS)
131-131: Fix grammar in the introduction sentenceAdd the missing word "to" in the sentence.
-While Wave provides an option disable `wsh` when first connecting to a remote +While Wave provides an option to disable `wsh` when first connecting to a remote🧰 Tools
🪛 LanguageTool
[uncategorized] ~131-~131: Possible missing preposition found.
Context: ...nnection While Wave provides an option disablewshwhen first connecting to a remote...(AI_HYDRA_LEO_MISSING_TO)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/docs/connections.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/connections.mdx
[grammar] ~81-~81: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...ple Internal Configurations Here are a couple examples of things you can do using the internal...
(PLENTY_OF_NOUNS)
[uncategorized] ~85-~85: Possible missing comma found.
Context: ...environment. In that case, you can hide it as in the example below: ```json { ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~131-~131: Possible missing preposition found.
Context: ...nnection While Wave provides an option disable wsh when first connecting to a remote...
(AI_HYDRA_LEO_MISSING_TO)
🔇 Additional comments (2)
docs/docs/connections.mdx (2)
87-95: Improve JSON example clarity and validity
The current JSON example uses invalid placeholders. Consider showing a complete, minimal example instead.
{
- <... other connections go here ...>,
"git@github.com" : {
"display:hidden": true
- },
- <... other connections go here ...>
+ }
}79-144: Overall improvements look good!
The new examples section significantly enhances the documentation by providing clear, practical examples for common connection configurations. The examples are well-structured and cover important use cases.
🧰 Tools
🪛 LanguageTool
[grammar] ~81-~81: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...ple Internal Configurations Here are a couple examples of things you can do using the internal...
(PLENTY_OF_NOUNS)
[uncategorized] ~85-~85: Possible missing comma found.
Context: ...environment. In that case, you can hide it as in the example below: ```json { ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~131-~131: Possible missing preposition found.
Context: ...nnection While Wave provides an option disable wsh when first connecting to a remote...
(AI_HYDRA_LEO_MISSING_TO)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/docs/connections.mdx (2)
81-81: Improve grammar in introductionFor more formal documentation, consider adding "of" after "couple".
-Here are a couple examples of things you can do using the internal configuration file `connections.json`: +Here are a couple of examples of things you can do using the internal configuration file `connections.json`:🧰 Tools
🪛 LanguageTool
[grammar] ~81-~81: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...ple Internal Configurations Here are a couple examples of things you can do using the internal...(PLENTY_OF_NOUNS)
131-131: Fix grammar in introductionAdd the missing preposition "to".
-While Wave provides an option disable `wsh` +While Wave provides an option to disable `wsh`🧰 Tools
🪛 LanguageTool
[uncategorized] ~131-~131: Possible missing preposition found.
Context: ...nnection While Wave provides an option disablewshwhen first connecting to a remote...(AI_HYDRA_LEO_MISSING_TO)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/docs/connections.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/connections.mdx
[grammar] ~81-~81: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...ple Internal Configurations Here are a couple examples of things you can do using the internal...
(PLENTY_OF_NOUNS)
[uncategorized] ~85-~85: Possible missing comma found.
Context: ...environment. In that case, you can hide it as in the example below: ```json { ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~131-~131: Possible missing preposition found.
Context: ...nnection While Wave provides an option disable wsh when first connecting to a remote...
(AI_HYDRA_LEO_MISSING_TO)
🔇 Additional comments (2)
docs/docs/connections.mdx (2)
87-95: Use valid JSON in examples
The placeholder text <... other connections go here ...> with commas makes the JSON invalid.
{
- <... other connections go here ...>,
"git@github.com" : {
"display:hidden": true
- },
- <... other connections go here ...>
+ }
}133-141:
Fix inconsistency in configuration key name
The configuration key conn:enablewsh doesn't match the documented key conn:wshenabled from the configuration table above.
{
<... other connections go here ...>,
"root@wshless" : {
- "conn:enablewsh": false,
+ "conn:wshenabled": false
},
<... other connections go here ...>
}Likely invalid or redundant comment.
Adds a few examples to the
connections.mdxfile to show:Summary by CodeRabbit