update readmes

reearth · Jun 6, 2023 · 976835e · 976835e
1 parent 1b5c0c9
commit 976835e
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 5 deletions.
diff --git a/web/src/beta/components/README.md b/web/src/beta/components/README.md
@@ -1 +1 @@
-# All reusable components
+# All basic components being reused in multiple places in the app
diff --git a/web/src/beta/features/README.md b/web/src/beta/features/README.md
@@ -1 +1,20 @@
-# App-specific features (ie header, left panel, Visualizer (uses core), widgets, etc)
+# App-specific features 
+
+A feature is self-contained. It contains everything inside its subdirectories except for any shared components which will be in `components/`.
+
+ex.
+
+```
+features/
+   Editor/
+      Visualizer/
+         ...
+      SidePanel/
+         ...
+      VisualizerNav/
+         ...
+      ...
+```
+
+Here we have the Editor as a feature. To make the Editor work, the Visualizer, SidePanels, and the VisualizerNav are all necessary to make the Editor work. 
+Any Buttons, Icons, etc will be generic and imported from `components/`.
diff --git a/web/src/beta/hooks/README.md b/web/src/beta/hooks/README.md
@@ -1 +1,3 @@
-# Shared (“global”) level hooks (ie. project creation/fetching/etc, workspace deleting/etc, etc)
+# Global hooks
+
+Hooks that will be used in multiple places throughout the source code. An example would be a project creation callback that wraps the GraphQL mutation and any default arguments we don't want to repeat in many places.
diff --git a/web/src/beta/pages/README.md b/web/src/beta/pages/README.md
@@ -1 +1,4 @@
-# The main page components (single files, simple)(dashboard, classic editor, experimental, published visualizer, settings)
+#  Top-level components
+
+The main pages of the app. They should be single files (`hooks.ts` files only if completely necessary) and simple.
+Here is where we will wrap in the Auth provider when necessary and build up the page from its features.
diff --git a/web/src/beta/utils/README.md b/web/src/beta/utils/README.md
@@ -1 +1,3 @@
-# Utility functions used throughout the app
+# Utility functions used throughout the app
+
+Any utils that are not used in multiple places don't need to go here.
diff --git a/web/src/classic/README.md b/web/src/classic/README.md
@@ -0,0 +1,3 @@
+# Classic Re:Earth UI and functionality
+
+In mostly maintenance mode. Bug fixes and stability might be merged, but this section of the source code will be relatively unchanged moving forward.