chore: reorganize files

Parkreiner · Parkreiner · commit e86207ed8a4d · 2023-10-03T12:57:18.000Z
diff --git a/site/src/components/OverflowY/OverflowY.tsx b/site/src/components/OverflowY/OverflowY.tsx
@@ -1,3 +1,6 @@
+/**
+ * @file Provides reusable vertical overflow behavior.
+ */
 import { type ReactNode } from "react";
 import { type SystemStyleObject } from "@mui/system";
 import Box from "@mui/system/Box";
diff --git a/site/src/components/PopoverContainer/PopoverContainer.tsx b/site/src/components/PopoverContainer/PopoverContainer.tsx
@@ -1,3 +1,10 @@
+/**
+ * @file Abstracts over MUI's Popover component to simplify using it (and hide)
+ * some of the wonkier parts of the API.
+ *
+ * Just place a button and some content in the component, and things just work.
+ * No setup needed with hooks or refs.
+ */
 import {
   type KeyboardEvent,
   type ReactElement,
diff --git a/site/src/pages/WorkspacesPage/WorkspacesButton.tsx b/site/src/pages/WorkspacesPage/WorkspacesButton.tsx
@@ -4,18 +4,20 @@ import { useOrganizationId, usePermissions } from "hooks";
 import { useQuery } from "@tanstack/react-query";
 import { type Template } from "api/typesGenerated";
 import { templates } from "api/queries/templates";
+
 import { Link as RouterLink } from "react-router-dom";
 import Box from "@mui/system/Box";
 import Button from "@mui/material/Button";
 import Link from "@mui/material/Link";
 import AddIcon from "@mui/icons-material/AddOutlined";
 import OpenIcon from "@mui/icons-material/OpenInNewOutlined";
+
 import { Loader } from "components/Loader/Loader";
-import { PopoverContainer } from "./PopoverContainer";
-import { OverflowY } from "./OverflowY";
-import { SearchBox } from "./SearchBox";
+import { PopoverContainer } from "components/PopoverContainer/PopoverContainer";
+import { OverflowY } from "components/OverflowY/OverflowY";
 import { EmptyState } from "components/EmptyState/EmptyState";
 import { Avatar } from "components/Avatar/Avatar";
+import { SearchBox } from "./WorkspacesSearchBox";
 
 const ICON_SIZE = 18;
 const COLUMN_GAP = 1.5;
diff --git a/site/src/pages/WorkspacesPage/WorkspacesPageView.tsx b/site/src/pages/WorkspacesPage/WorkspacesPageView.tsx
@@ -18,7 +18,7 @@ import {
 import Box from "@mui/material/Box";
 import Button from "@mui/material/Button";
 import DeleteOutlined from "@mui/icons-material/DeleteOutlined";
-import { WorkspacesButton } from "components/WorkspacesButton/WorkspacesButton";
+import { WorkspacesButton } from "./WorkspacesButton";
 
 export const Language = {
   pageTitle: "Workspaces",
diff --git a/site/src/pages/WorkspacesPage/WorkspacesSearchBox.tsx b/site/src/pages/WorkspacesPage/WorkspacesSearchBox.tsx
@@ -1,3 +1,9 @@
+/**
+ * @file Defines a controlled searchbox component for processing form state.
+ *
+ * Not defined as a top-level component just yet, because it's not clear how
+ * reusable this is outside of workspace dropdowns.
+ */
 import {
   type ForwardedRef,
   type KeyboardEvent,
