Improve internal development documentation

Author: wwwillchen

docs/internal/ci.md

@@ -0,0 +1,3 @@
+# CI
+
+We use GitHub actions. For all third-party GitHub actions, we must pin it to a specific hash to comply with internal policies.

docs/development.md renamed to docs/internal/development.md

@@ -93,22 +93,6 @@ $ pip install -r optic/requirements_lock.txt
 
 > NOTE: You may need to run the command with `sudo` if you get a permission denied error, particularly with "\_distutils_hack".
 
-### Type-checking (pyright)
-
-We use [pyright](https://github.com/microsoft/pyright) for type-checking our Python code because it has excellent IDE support (particularly for VS Code).
-
-To run type-checking, please follow the above steps to setup the venv and activate it in your shell session.
-
-**Pre-requisite:**
-
-- You will need to run `$ setup_proto_py_modules.sh`.
-
-**Command:**
-
-```sh
-$ pyright
-```
-
 ## Commit hooks
 
 We use [pre-commit](https://pre-commit.com/) to automatically format, lint code before committing.
@@ -118,10 +102,6 @@ _Setup:_
 1. [Install pre-commit](https://pre-commit.com/#installation).
 1. Setup git hook: `pre-commit install`
 
-## Web (Angular)
-
-<TODO>
-
 ## Docs
 
 We use [Mkdocs Material](https://squidfunk.github.io/mkdocs-material/) to generate our docs site.

docs/new_component.md renamed to docs/internal/new_component.md

@@ -0,0 +1,15 @@
+# Testing
+
+We use [Playwright](https://playwright.dev/) as our e2e test framework. Unlike most of the stack, this isn't Bazel-ified although we'd like to eventually do this.
+
+## Run tests
+
+```shell
+$ yarn playwright test
+```
+
+## Debug tests
+
+```shell
+$ yarn playwright test --debug
+```

docs/internal/testing.md

@@ -0,0 +1,3 @@
+# Toolchain
+
+We rely heavily on Angular's toolchain, particularly around Bazel integration. Many of the Bazel rules, particularly for Angular/TS code was forked from [github.com/angular/components](https://github.com/angular/components).

docs/internal/toolchain.md

@@ -0,0 +1,13 @@
+# Type Checking
+
+## Python Type Checking
+
+For our Python code, we use [pyright](https://github.com/microsoft/pyright) as our static type checker because it has excellent IDE support in VS Code via [pylance](https://github.com/microsoft/pylance-release).
+
+To run Python type-checking, run:
+
+```shell
+$ ./scripts/run_py_typecheck.sh
+```
+
+This will setup the pre-requisites needed for type-checking.

docs/internal/type_checking.md

@@ -9,11 +9,15 @@ nav:
       - Checkbox: components/checkbox.md
       - Text: components/text.md
   - Deployment: deployment.md
-  - Goals: goals.md
   - Troubleshooting: troubleshooting.md
-  - Advanced:
-      - New component: new_component.md
-      - Development: development.md
+  - Developing Optic:
+      - Goals: goals.md
+      - New component: internal/new_component.md
+      - Development: internal/development.md
+      - Testing: internal/testing.md
+      - Type checking: internal/type_checking.md
+      - CI: internal/ci.md
+      - Toolchain: internal/toolchain.md
 theme:
   name: material
   logo: assets/logo.png