-
Notifications
You must be signed in to change notification settings - Fork 294
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
add preview:showhiddenfiles to config docs #1619
Conversation
WalkthroughThe pull request introduces a new configuration key 🪧 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 (
|
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
🧹 Nitpick comments (1)
docs/docs/config.mdx (1)
Line range hint
147-171
: Consider updating the default configuration example.Since
preview:showhiddenfiles
has a default value oftrue
, consider adding it to the default configuration JSON example to maintain completeness of documentation.{ "ai:preset": "ai@global", "ai:model": "gpt-4o-mini", "ai:maxtokens": 2048, "ai:timeoutms": 60000, "autoupdate:enabled": true, "autoupdate:installonquit": true, "autoupdate:intervalms": 3600000, "conn:askbeforewshinstall": true, "conn:wshenabled": true, "editor:minimapenabled": true, + "preview:showhiddenfiles": true, "web:defaulturl": "https://github.com/wavetermdev/waveterm", "web:defaultsearch": "https://www.google.com/search?q={query}", "window:tilegapsize": 3, "window:maxtabcachesize": 10, "window:nativetitlebar": true, "window:magnifiedblockopacity": 0.6, "window:magnifiedblocksize": 0.9, "window:magnifiedblockblurprimarypx": 10, "window:magnifiedblockblursecondarypx": 2, "window:confirmclose": true, "window:savelastwindow": true, "telemetry:enabled": true, "term:copyonselect": true }
🧰 Tools
🪛 LanguageTool
[grammar] ~50-~50: Did you mean “too false to”?
Context: ...enabled | bool | set to false to disable editor minimap ...(TOO_ADJECTIVE_TO)
[grammar] ~53-~53: Did you mean “too false to”?
Context: ...ddenfiles | bool | set to false to disable showing hidden files in the dir...(TOO_ADJECTIVE_TO)
[grammar] ~56-~56: Did you mean “too false to”?
Context: ...nternally | bool | set to false to open web links in external browser ...(TOO_ADJECTIVE_TO)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/docs/config.mdx
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/config.mdx
[grammar] ~53-~53: Did you mean “too false to”?
Context: ...ddenfiles | bool | set to false to disable showing hidden files in the dir...
(TOO_ADJECTIVE_TO)
🔇 Additional comments (1)
docs/docs/config.mdx (1)
53-53
: LGTM! Documentation is clear and well-integrated.
The new configuration key is documented clearly with proper formatting, consistent style, and explicit default value specification. The entry fits naturally within the configuration documentation.
🧰 Tools
🪛 LanguageTool
[grammar] ~53-~53: Did you mean “too false to”?
Context: ...ddenfiles | bool | set to false to disable showing hidden files in the dir...
(TOO_ADJECTIVE_TO)
No description provided.