docs: update settings.md with comprehensive steps #2451
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update the settings documentation to include all necessary steps for adding a new configuration item, including schema definitions, type definitions, and critical steps for persistence and UI display. This ensures the documentation accurately reflects the complete process required when adding new settings to the application. Signed-off-by: Eric Wheeler <[email protected]>
|
dosubot
bot
added
size:S
Add documentation about styling checkbox settings in the UI, including: - Using VSCodeCheckbox component - Proper wrapping and spacing - Consistent styling for labels and descriptions - Example implementation based on terminalPowershellCounter Signed-off-by: Eric Wheeler <[email protected]>
dosubot
bot
added
size:M
Contributor
|
Thanks! |
Add a new section to settings.md that provides a complete checklist for adding new configuration items to the system. This guide covers all aspects from UI to persistence to functionality, based on implementation experience. Signed-off-by: Eric Wheeler <[email protected]>
dosubot
bot
added
size:L
Add comprehensive guidance for ensuring settings persist across reload Include debugging steps for troubleshooting persistence issues Replace 'Avoiding Duplicates' section with more detailed information Signed-off-by: Eric Wheeler <[email protected]>
mrubens
approved these changes
Apr 11, 2025
github-project-automation
bot
moved this from PR [Pre Approval Review]
to Done
in Roo Code Roadmap
SmartManoj
pushed a commit
to SmartManoj/Raa-Code
that referenced
this pull request
May 6, 2025
* manual port * successfully open remote chrome * clean up auto-detect vs specified path * move the browser settings into regular settings * changeset & prettier * correct chrome path description, remove some old comments, and rename headless mode to local mode * rename incorrect headless mode to 'local mode' * Sub-PR of hugelung/remote_browser: clicking browser widget's gear opens basic settings & scrolls down with a highlight (RooCodeInc#2439) * first version of scrolling to browser settings * really nice generic scroll to settings & highlight * formatting & changeset --------- Co-authored-by: Andrei Edell <[email protected]> * added feature to detect and display chrome path as placeholder in browser settings (RooCodeInc#2442) Co-authored-by: Andrei Edell <[email protected]> * Features to relaunch browser in debug, test connection (RooCodeInc#2440) * Features to Relaunch browser in debug, test connection * Update src/services/browser/BrowserSession.ts Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> * Update webview-ui/src/components/browser/BrowserSettingsMenu.tsx Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> --------- Co-authored-by: Andrei Edell <[email protected]> Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> * fix a merge conflict resolution error * fix linter issue * clarify settings descriptions * Remove sketchy network scanning code * respect viewport size in remote host * headless browser fix (RooCodeInc#2451) * Disable notifications in browser * start of info panel popover (RooCodeInc#2453) * start of info panel popover * remove duplicated message & prettier fix * Revert "remove duplicated message & prettier fix" This reverts commit dcefef35aacfc9d9a8461d37805c2ffb64b558c4. * info styling, close browser tab, hide headless info --------- Co-authored-by: Andrei Edell <[email protected]> * remove headless checkbox * settings layout rework & more auto * new chrome flags experiments * make headless choice automatic & phrasing & visual cleanups * auto-recheck chrome connection every second - while we are looking at settings - while we have remote debugging enabled * continuous remote connection testing & ux cleanup * remove advanced settings from package.json * format fixes * dont display connection type after dc to smooth over ui of reloading tasks * seems we need package-lock now for ci * Revert "remove advanced settings from package.json" This reverts commit 5defe4a8cae7631bcf9c1fb9efa874e3238c5034. * relaunch correctly with default session * prevent about:blank opening on relaunch * Resolve merge conflicts with refactor * add browser tool telemetry * try launching chrome using node spawn_child to detach it * browser settings update * do async dispose for browsersession * remove duplicated message implementation * Remove remote browser settings from configuration, and enhance browser settings UI with an advanced settings button. * Remove updateBrowserSettings * Fix text with chrome path * fix arafat's pr note about multiple timers * fix saoud's note about require use * Remote browser logging (RooCodeInc#2682) * logging * reduce logging levels --------- Co-authored-by: Andrei Edell <[email protected]> * Make browser status popup adapt to viewport width * remove requires for exec/spawn * remove unneeded comments * error telemetry * remove headless mode / settings everywhere * migrate values list to simple endpoint string * fix log spam and clean up a comment * Fixes; copy * Remove local state since we're already using extension state * Remove unnecessary remoteBrowserHost and remoteBrowserEnabled states * Fix status wrapping --------- Co-authored-by: Andrei Edell <[email protected]> Co-authored-by: canvrno <[email protected]> Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> Co-authored-by: canvrno <[email protected]> Co-authored-by: Saoud Rizwan <[email protected]> Co-authored-by: frostbournesb <[email protected]> Co-authored-by: Dennis Bartlett <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the settings documentation to include all necessary steps for adding a new configuration item, including schema definitions, type definitions, and critical steps for persistence and UI display.
This ensures the documentation accurately reflects the complete process required when adding new settings to the application.
Important
Updates
settings.mdto provide comprehensive steps for adding new configuration items, covering schema definitions, type definitions, persistence, and UI display.settings.mdto include steps for adding new configuration items.schemas/index.tsand type definitions inexports/types.ts,exports/roo-code.d.ts,shared/ExtensionMessage.ts, andshared/WebviewMessage.ts.ClineProvider.test.ts.ExtensionStateContext.tsx,ClineProvider.ts, andSettingsView.tsx.vscode.postMessagecalls inSettingsView.tsx.This description was created by
for 7ec5fac. It will automatically update as commits are pushed.