diff --git a/web/src/beta/components/README.md b/web/src/beta/components/README.md index 922890d23b..1ba48727c4 100644 --- a/web/src/beta/components/README.md +++ b/web/src/beta/components/README.md @@ -1 +1 @@ -# All reusable components \ No newline at end of file +# All basic components being reused in multiple places in the app \ No newline at end of file diff --git a/web/src/beta/features/README.md b/web/src/beta/features/README.md index 7b8414bc59..8ac2e7d5ca 100644 --- 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) \ No newline at end of file +# 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/`. \ No newline at end of file diff --git a/web/src/beta/hooks/README.md b/web/src/beta/hooks/README.md index e208143ac8..dad91ec81b 100644 --- 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) \ No newline at end of file +# 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 index ab7a318959..0639525c8a 100644 --- 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) \ No newline at end of file +# 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 index 6290f9517d..049b4fc7ae 100644 --- a/web/src/beta/utils/README.md +++ b/web/src/beta/utils/README.md @@ -1 +1,3 @@ -# Utility functions used throughout the app \ No newline at end of file +# Utility functions used throughout the app + +Any utils that are not used in multiple places don't need to go here. \ No newline at end of file diff --git a/web/src/classic/README.md b/web/src/classic/README.md new file mode 100644 index 0000000000..6963bf1db7 --- /dev/null +++ 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. \ No newline at end of file