update

crates/workspace/src/views/sidebar/create_repo_dialog.rs

@@ -24,10 +24,9 @@ pub struct CreateRepoState {
 }
 
 /// Open the Create Repository dialog.
-///
-/// The dialog loads the user's default grasp servers (kind `10317` grasp
-/// list) and falls back to the shared defaults when none are set. On
-/// success the dialog closes and the new repository opens in the dock.
+/// Loads the user's default grasp servers, a kind `10317` grasp list.
+/// Falls back to the shared defaults when none are set.
+/// On success the dialog closes and the new repository opens in the dock.
 pub fn open(dock_area: WeakEntity<DockArea>, window: &mut Window, cx: &mut App) {
     let settings = SettingsStore::global(cx);
     let default_folder = settings
@@ -160,10 +159,9 @@ pub fn open(dock_area: WeakEntity<DockArea>, window: &mut Window, cx: &mut App)
     });
 }
 
-/// Prompt the user to pick the folder the repository will be stored in, using
-/// the platform's native folder picker, and show the result in the disabled
-/// folder input. The picked folder is remembered in the settings so it
-/// becomes the default next time.
+/// Pick the repository's storage folder with the platform's native folder picker.
+/// Show the result in the disabled folder input.
+/// The settings remember the picked folder as the default next time.
 fn choose_folder(folder_input: &Entity<InputState>, window: &mut Window, cx: &mut App) {
     let handle = window.window_handle();
     let folder_input = folder_input.clone();
@@ -198,8 +196,8 @@ fn choose_folder(folder_input: &Entity<InputState>, window: &mut Window, cx: &mu
     .detach();
 }
 
-/// Run the create-repository flow,
-/// opens the new working copy and the repository panel on success.
+/// Run the create-repository flow.
+/// Opens the new working copy and the repository panel on success.
 #[allow(clippy::too_many_arguments)]
 fn create_repository(
     name_input: Entity<InputState>,
@@ -247,8 +245,8 @@ fn create_repository(
         Ok((announcement, local_path)) => {
             cx.update_window(handle, |_, window, cx| {
                 window.close_dialog(cx);
-                // Remember the new working copy as a checkout of this
-                // repository, so the New PR panel pre-fills it.
+                // Record the new working copy as a checkout of this repository.
+                // The New PR panel then pre-fills it.
                 let checkouts = CheckoutsStore::global(cx);
                 checkouts.update(cx, |store, cx| {
                     store.record(local_path.clone(), announcement.addr(), cx);

crates/workspace/src/views/sidebar/grasp_servers.rs

@@ -9,24 +9,21 @@ use settings::{DEFAULT_GRASP_SERVERS, GraspServersSettings};
 use signed_core::filters;
 use signed_state::Backend;
 
-/// State of the grasp-server section of a publish dialog, so async
-/// results can be rendered.
+/// State of the grasp-server section of a publish dialog, so async results can be rendered.
 #[derive(Default)]
 pub struct GraspServersState {
-    /// The user's grasp list (kind `10317`) is being loaded.
+    /// The user's grasp list of kind `10317` is being loaded.
     pub loading_servers: bool,
     pub grasp_servers: Vec<RelayUrl>,
-    /// Whether the grasp server section is shown; defaults to shown.
+    /// Whether the grasp server section is shown. Defaults to shown.
     pub servers_enabled: bool,
-    /// Error of the last grasp-server edit (e.g. an invalid relay URL).
+    /// Error of the last grasp-server edit, an invalid relay URL for example.
     pub error: Option<SharedString>,
 }
 
 impl GraspServersState {
-    /// Defaults until the user's grasp list arrives; replaced by it when it lists any servers.
-    ///
-    /// The servers come from the persisted settings, falling back to the
-    /// built-in defaults when the configured list is empty.
+    /// Defaults used until the user's grasp list loads, which replaces them when non-empty.
+    /// Persisted settings supply the defaults, an empty list falls back to the built-ins.
     pub fn new_default(settings: &GraspServersSettings) -> Self {
         let urls: Vec<String> = if settings.default_servers.is_empty() {
             DEFAULT_GRASP_SERVERS
@@ -48,10 +45,9 @@ impl GraspServersState {
     }
 }
 
-/// The "Grasp servers" form field shared by the publish dialogs: an
-/// expandable toggle, the configured servers (each removable) and an
-/// add-relay input, with a loading hint while the user's grasp list
-/// (kind `10317`) is being fetched.
+/// The Grasp servers form field shared by the publish dialogs.
+/// An expandable toggle, the configured servers each removable, and an add-relay input.
+/// Shows a loading hint while the user's kind `10317` grasp list is fetched.
 pub fn grasp_servers_field(
     state: &Entity<GraspServersState>,
     relay_input: &Entity<InputState>,
@@ -143,7 +139,7 @@ pub fn grasp_servers_field(
         }))
 }
 
-/// A grasp server row: the host as a tag plus a remove button.
+/// One grasp server row, the host in a tag plus a remove button.
 fn render_server_row(
     ix: usize,
     relay: &RelayUrl,
@@ -182,7 +178,7 @@ fn render_server_row(
         )
 }
 
-/// The bare host of a grasp server (defaults are entered without a scheme).
+/// The bare host of a grasp server, defaults are entered without a scheme.
 fn display_server(relay: &RelayUrl) -> SharedString {
     relay
         .domain()
@@ -190,7 +186,7 @@ fn display_server(relay: &RelayUrl) -> SharedString {
         .unwrap_or_else(|| SharedString::from(relay.to_string()))
 }
 
-/// Parse the relay input (accepting a bare host) and append it to the list.
+/// Parse the relay input, accepting a bare host, and append it to the list.
 fn add_relay(
     state: &Entity<GraspServersState>,
     input: &Entity<InputState>,
@@ -226,8 +222,8 @@ fn add_relay(
     }
 }
 
-/// Load the user's grasp list (kind `10317`) from the local database and
-/// replace the defaults with it when it lists any servers.
+/// Load the user's grasp list of kind `10317` from the local database.
+/// It replaces the defaults when it lists any servers.
 pub fn load_user_grasp_servers(
     state: Entity<GraspServersState>,
     window: &mut Window,

crates/workspace/src/views/sidebar/import_dialog.rs

@@ -2,8 +2,7 @@ use gpui::{App, Window, px};
 use gpui_component::WindowExt;
 
 /// Open the Import Identity dialog.
-///
-/// Currently a placeholder — the dialog only shows a title for now.
+/// Currently a placeholder, the dialog only shows a title.
 pub fn open(window: &mut Window, cx: &mut App) {
     window.open_dialog(cx, move |dialog, _window, _cx| {
         dialog.title("Import identity").width(px(400.))

crates/workspace/src/views/sidebar/mod.rs

@@ -32,25 +32,25 @@ mod settings_dialog;
 
 use self::onboarding_dialog::OnboardingState;
 
-/// Left-dock panel with navigation entries. Entries open content panels in
-/// the dock area.
+/// Left-dock panel with navigation entries.
+/// Entries open content panels in the dock area.
 pub struct SidebarPanel {
     focus_handle: FocusHandle,
     dock_area: WeakEntity<DockArea>,
     explore: Option<WeakEntity<RepoListView>>,
     logged_in: bool,
-    /// Repositories announced by the current user, listed under
-    /// "All Repositories". Recreated when the signer changes.
+    /// Repositories the current user announced, listed under the All Repositories heading.
+    /// Recreated when the signer changes.
     my_repos: Option<Entity<RepoListStore>>,
     /// Observes the current user's repo store so the list re-renders.
     my_repos_subscription: Option<Subscription>,
-    /// Banner artwork shown behind the sign-in screen,
-    /// picked at random from the bundled `backgrounds/` assets.
+    /// Banner artwork behind the sign-in screen.
+    /// Picked at random from the bundled `backgrounds/` assets.
     banner: SharedString,
     /// Observes the local-repository scan so new discoveries re-render.
     _local_repos_subscription: Subscription,
-    /// Observes the checkouts store, whose ready-to-push statuses feed the
-    /// badges on the user's repository rows.
+    /// Observes the checkouts store.
+    /// Its ready-to-push statuses feed the badges on the user's repo rows.
     _checkouts_subscription: Subscription,
     _subscription: Subscription,
 }
@@ -107,8 +107,8 @@ impl SidebarPanel {
         panel
     }
 
-    /// (Re)create the store listing the current user's repositories,
-    /// and watch each of them for unpushed local work.
+    /// Recreate the store listing the current user's repositories.
+    /// Watch each repository for unpushed local work.
     fn refresh_my_repos(&mut self, cx: &mut Context<Self>) {
         self.my_repos_subscription = None;
 
@@ -119,9 +119,9 @@ impl SidebarPanel {
         if let Some(store) = self.my_repos.as_ref() {
             self.my_repos_subscription = Some(cx.observe(store, |_this, store, cx| {
                 cx.notify();
-                // These are the signed-in user's own repositories; request
-                // their ready-to-push statuses (deduplicated per repo) so
-                // the rows carry a badge while local work is unpushed.
+                // These are the signed-in user's own repositories.
+                // Request their ready-to-push statuses, deduplicated per repository.
+                // The rows carry a badge while local work is unpushed.
                 let addrs: Vec<_> = store
                     .read(cx)
                     .announcements
@@ -138,8 +138,8 @@ impl SidebarPanel {
         }
     }
 
-    /// Open the Explore (repository list) panel in the center of the dock
-    /// area. No-op if it's already open.
+    /// Open the Explore repository list panel in the dock area's center.
+    /// No-op if it is already open.
     pub fn open_explore(&mut self, window: &mut Window, cx: &mut Context<Self>) {
         if self
             .explore
@@ -191,8 +191,8 @@ impl SidebarPanel {
         open_repo_panel(&self.dock_area, announcement, window, &mut *cx);
     }
 
-    /// Open a local repository's detail view in the dock's center; the
-    /// detail view offers to publish it to NIP-34.
+    /// Open a local repository's detail view in the dock's center.
+    /// The detail view offers to publish it to NIP-34.
     fn open_local_repo(&mut self, path: PathBuf, window: &mut Window, cx: &mut Context<Self>) {
         let detail =
             cx.new(|cx| RepoDetailView::new_local(self.dock_area.clone(), path, window, cx));
@@ -208,10 +208,10 @@ impl SidebarPanel {
         });
     }
 
-    /// The "All Repositories" section: header with the create button and
-    /// the current user's repositories below it, lazily rendered through a
-    /// [`uniform_list`], followed by the local git repositories discovered
-    /// by the startup scan.
+    /// The All Repositories section of the sidebar.
+    /// A header with the create button above the current user's repositories.
+    /// Rendered lazily through a [`uniform_list`].
+    /// Followed by local git repositories from the startup scan.
     fn render_my_repos(&self, cx: &mut Context<Self>) -> impl IntoElement {
         let store = self.my_repos.as_ref();
         let local = LocalReposStore::global(cx);
@@ -265,11 +265,10 @@ impl SidebarPanel {
             )
             .when_some(store, |builder, store| {
                 let announcements = store.read(cx).announcements.clone();
-                // Local repositories that have already been published to
-                // NIP-34 are listed among the user's repositories above;
-                // hide them from the local section (matched by the
-                // identifier derived from the directory name, like the
-                // init dialog's default name).
+                // Local repositories already published to NIP-34 appear above.
+                // Hide them from the local section here.
+                // Matched by the identifier derived from the directory name.
+                // Same derivation as the init dialog's default name.
                 let announced_ids: HashSet<String> =
                     announcements.iter().map(|a| a.id.clone()).collect();
                 let local_repos: Vec<PathBuf> = local_repos
@@ -282,8 +281,8 @@ impl SidebarPanel {
                     })
                     .cloned()
                     .collect();
-                // One merged list: the user's NIP-34 repositories first,
-                // then the local repositories discovered by the scan.
+                // One merged list, the user's NIP-34 repositories first.
+                // Local repositories discovered by the scan follow.
                 let total = announcements.len() + local_repos.len();
 
                 if total == 0 {
@@ -326,8 +325,7 @@ impl SidebarPanel {
             })
     }
 
-    /// One row of the merged sidebar list: a NIP-34 repository or a local
-    /// repository.
+    /// One row of the merged sidebar list, a NIP-34 or a local repository.
     fn render_repo_row_at(
         &self,
         announcements: &[Announcement],
@@ -358,8 +356,8 @@ impl SidebarPanel {
             .unwrap_or_else(|| SharedString::from(announcement.id.clone()));
         let avatar = PixelAvatar::new(format!("{}:{}", announcement.owner, announcement.id));
 
-        // A small badge with the unpushed commit count of the repository's
-        // local checkouts (ready to push to the grasp servers).
+        // Badge with the unpushed commit count of the repository's local checkouts.
+        // The commits are ready to push to the grasp servers.
         let unpushed: usize = CheckoutsStore::global(cx)
             .read(cx)
             .push_statuses_of(&announcement.addr())
@@ -379,10 +377,9 @@ impl SidebarPanel {
         )
     }
 
-    /// One local repository row: a deterministic pixel avatar seeded from
-    /// the path, the directory name, and a warning suffix marking it as
-    /// not yet set up for NIP-34. Clicking it opens the repository's
-    /// detail view, which offers to initialize it.
+    /// One local repository row, a deterministic pixel avatar seeded from the path.
+    /// The directory name and a warning suffix, the repo is not yet set up for NIP-34.
+    /// Clicking opens the detail view, which offers to initialize it.
     fn render_local_row(&self, path: &Path, cx: &mut Context<Self>) -> impl IntoElement {
         let name = path
             .file_name()
@@ -410,7 +407,7 @@ impl SidebarPanel {
         import_dialog::open(window, cx);
     }
 
-    /// Render the user avatar and name in the sidebar, wrapped in the window titlebar drag area.
+    /// Render the user avatar and name in the sidebar, inside the titlebar drag area.
     fn render_user(
         &self,
         profile: &Profile,
@@ -440,8 +437,8 @@ impl SidebarPanel {
         )
     }
 
-    /// Sign-in placeholder shown while logged out: banner artwork behind a
-    /// scrim so the CTA buttons stay readable in both themes.
+    /// Sign-in placeholder shown while logged out.
+    /// Banner artwork behind a scrim keeps the CTA buttons readable in both themes.
     fn render_sign_in(&self, window: &mut Window, cx: &mut Context<Self>) -> Div {
         v_flex()
             .size_full()

crates/workspace/src/views/sidebar/onboarding_dialog.rs

@@ -15,10 +15,8 @@ pub struct OnboardingState {
 }
 
 /// Open the Onboarding dialog for creating a new identity.
-///
-/// The caller is responsible for creating the input and state entities and
-/// passing them in. This function only builds the dialog UI and wires up
-/// the continue-button handler.
+/// The caller creates the input and state entities and passes them in.
+/// This function only builds the dialog UI and wires up the continue-button handler.
 pub fn open(
     name_input: Entity<InputState>,
     pass_input: Entity<InputState>,

crates/workspace/src/views/sidebar/passphrase_dialog.rs

@@ -17,9 +17,8 @@ pub struct PassphraseState {
     _enter_subscription: Option<Subscription>,
 }
 
-/// Open the dialog asking for the passphrase that protects the stored
-/// NIP-49 encrypted identity (`ncryptsec1...`).
-///
+/// Open the dialog asking for the passphrase that protects the stored identity.
+/// The identity is NIP-49 encrypted, for example `ncryptsec1...`.
 /// Called when the backend emits [`signed_state::BackendEvent::PassphraseRequired`].
 pub fn open(window: &mut Window, cx: &mut App) {
     let pass_input = cx.new(|cx| {
@@ -98,8 +97,9 @@ pub fn open(window: &mut Window, cx: &mut App) {
     });
 }
 
-/// Submit the passphrase to the backend. On success the dialog is closed;
-/// on failure the error is rendered inline and the dialog stays open.
+/// Submit the passphrase to the backend.
+/// On success the dialog closes.
+/// On failure the error is rendered inline and the dialog stays open.
 fn unlock(
     pass_input: &Entity<InputState>,
     state: &Entity<PassphraseState>,

crates/workspace/src/views/sidebar/settings_dialog.rs

@@ -1,10 +1,3 @@
-//! The Settings dialog, opened from the sidebar's Settings entry.
-//!
-//! A custom settings layout that divides related settings into sections
-//! separated by simple horizontal lines — no `GroupBox` boxes and no settings
-//! navigation sidebar. Every control edits the persisted [`SettingsStore`]
-//! and applies the change to the live theme immediately.
-
 use std::cell::Cell;
 use std::path::PathBuf;
 use std::rc::Rc;
@@ -55,8 +48,8 @@ fn theme_options(cx: &App) -> (Vec<SelectOption>, Vec<SelectOption>) {
     (light, dark)
 }
 
-/// Stateful controls of the settings dialog, created once when it opens so
-/// their values survive re-renders of the dialog content.
+/// Stateful controls of the settings dialog, created once when it opens.
+/// Their values survive re-renders of the dialog content.
 struct SettingsControls {
     appearance: Entity<SelectState<Vec<SelectOption>>>,
     light_theme: Entity<SelectState<Vec<SelectOption>>>,
@@ -66,8 +59,7 @@ struct SettingsControls {
     radius: Entity<InputState>,
     radius_lg: Entity<InputState>,
     grasp_server_input: Entity<InputState>,
-    /// The effective default create-repository folder, shown in the disabled
-    /// folder selector.
+    /// The effective default create-repository folder, shown in the disabled input.
     default_folder: Entity<InputState>,
     /// Keeps the control subscriptions alive for the dialog's lifetime.
     _subscriptions: Vec<Subscription>,
@@ -296,8 +288,8 @@ pub fn open(window: &mut Window, cx: &mut App) {
     });
 }
 
-/// The settings content: one section per related setting, divided by
-/// horizontal separator lines.
+/// The settings content, one section per related setting.
+/// Sections are divided by horizontal separator lines.
 fn settings_view(controls: &SettingsControls, cx: &mut App) -> impl IntoElement {
     let store = SettingsStore::global(cx);
     let settings = store.read(cx).settings().clone();
@@ -325,8 +317,7 @@ fn appearance_section(controls: &SettingsControls, cx: &App) -> impl IntoElement
     ))
 }
 
-/// Theme configuration: the theme names in the registry plus
-/// the visual tweaks the application customizes at startup.
+/// Theme configuration, the registry theme names plus tweaks the app customizes at startup.
 fn theme_section(settings: &Settings, controls: &SettingsControls, cx: &App) -> impl IntoElement {
     v_flex()
         .gap_3()
@@ -397,7 +388,7 @@ fn theme_section(settings: &Settings, controls: &SettingsControls, cx: &App) ->
         ))
 }
 
-/// The default grasp servers offered when the user hasn't published a grasp list (kind `10317`) yet.
+/// Default grasp servers offered until the user publishes a kind `10317` grasp list.
 fn grasp_servers_section(
     settings: &Settings,
     controls: &SettingsControls,
@@ -413,8 +404,8 @@ fn grasp_servers_section(
     ))
 }
 
-/// The editable list of default grasp servers plus an add-relay input,
-/// styled like the grasp-server section of the publish dialogs.
+/// The editable list of default grasp servers plus an add-relay input.
+/// Styled like the grasp-server section of the publish dialogs.
 fn grasp_server_editor(
     servers: &[String],
     controls: &SettingsControls,
@@ -478,8 +469,8 @@ fn grasp_server_editor(
         )
 }
 
-/// The bare host of a grasp server (defaults are entered without a scheme),
-/// matching how the publish dialogs display servers.
+/// The bare host of a grasp server, defaults are entered without a scheme.
+/// Matches how the publish dialogs display servers.
 fn display_server(server: &str) -> SharedString {
     RelayUrl::parse(server)
         .ok()
@@ -513,8 +504,8 @@ fn repositories_section(
         ))
 }
 
-/// The editable list of scan directories plus an add-directory button,
-/// styled like the grasp-server list.
+/// The editable list of scan directories plus an add-directory button.
+/// Styled like the grasp-server list.
 fn scan_paths_editor(scan_paths: &[PathBuf], cx: &App) -> impl IntoElement {
     v_flex()
         .w_full()
@@ -566,8 +557,8 @@ fn scan_paths_editor(scan_paths: &[PathBuf], cx: &App) -> impl IntoElement {
         )
 }
 
-/// The default-folder selector: a disabled input showing the effective
-/// folder plus a picker button, matching the create-repository dialog.
+/// The default-folder selector, a disabled input plus a picker button.
+/// Matches the create-repository dialog.
 fn folder_selector(controls: &SettingsControls) -> impl IntoElement {
     let default_folder = controls.default_folder.clone();
     h_flex()
@@ -590,8 +581,8 @@ fn folder_selector(controls: &SettingsControls) -> impl IntoElement {
         )
 }
 
-/// Parse the server input (accepting a bare host) and append it to the
-/// default grasp servers.
+/// Parse the server input and append it to the default grasp servers.
+/// A bare host is accepted.
 fn add_server(input: &Entity<InputState>, window: &mut Window, cx: &mut App) {
     let value = input.read(cx).value().trim().to_owned();
     if value.is_empty() {
@@ -660,8 +651,8 @@ fn add_scan_path(cx: &mut App) {
     .detach();
 }
 
-/// Prompt for the folder the Create Repository dialog should default to,
-/// remembering it in the settings and showing it in the disabled input.
+/// Prompt for the Create Repository dialog's default folder.
+/// Remember it in the settings and show it in the disabled input.
 fn choose_default_folder(default_folder: &Entity<InputState>, window: &mut Window, cx: &mut App) {
     let handle = window.window_handle();
     let default_folder = default_folder.clone();
@@ -695,8 +686,9 @@ fn choose_default_folder(default_folder: &Entity<InputState>, window: &mut Windo
     .detach();
 }
 
-/// Wire a number input to the settings: steps clamp and persist, typed
-/// changes parse, clamp and persist.
+/// Wire a number input to the settings.
+/// Step actions clamp and persist the value.
+/// Typed changes parse, clamp and persist.
 fn wire_number_input(
     state: &Entity<InputState>,
     subscriptions: &mut Vec<Subscription>,