feat: add notes on running validation and testing

Author: paulswartz

.github/workflows/ci.yml

@@ -14,13 +14,5 @@ jobs:
         id: configure
       - name: Install
         run: yarn
-      - name: Check Formatting
-        run: yarn format --check
-      - name: Typecheck
-        run: yarn typecheck
-      - name: Tests
-        run: yarn test
-      - name: Validate schemas
-        run: yarn test:schemas
-      - name: Validate examples
-        run: yarn test:examples
+      - name: Check
+        run: yarn ci

README.md

@@ -16,6 +16,26 @@ $ yarn start
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
+### Schema Validation
+
+``` shell
+# Check that the schemas in `schemas/` are valid
+$ yarn test:schemas
+
+# Check that the examples in `examples/` match the schemas in `schemas/`
+$ yarn test:examples
+```
+
+### Testing
+
+``` shell
+$ yarn ci
+# or 
+$ yarn format --check
+$ yarn typecheck
+$ yarn test
+```
+
 ### Build
 
 ```

package.json

@@ -16,7 +16,8 @@
     "typecheck": "tsc",
     "test": "jest",
     "test:schemas": "ajv compile -s \"schemas/com.*.json\" --spec=draft2020 -c ajv-formats --strict=true -r \"schemas/cloudevents.json\" -r \"schemas/glides-events-schema.json\"",
-    "test:examples": "ts-node src/scripts/validate_examples.ts"
+    "test:examples": "ts-node src/scripts/validate_examples.ts",
+    "ci": "yarn format --check && yarn typecheck && yarn test && yarn test:schemas && yarn test:examples"
   },
   "dependencies": {
     "@docusaurus/core": "2.4.0",

src/components/EventSchemaPath.tsx

@@ -13,7 +13,7 @@ const viewerOptions = {
 export default function EventSchemaPath(props: { event: object }): JSX.Element {
   const [error, setError] = useState(undefined);
   const [resolvedSchema, setResolvedSchema] = useState(undefined);
-  const schemaRoot = useBaseUrl("/schemas", {forcePrependBaseUrl: true});
+  const schemaRoot = useBaseUrl("/schemas", { forcePrependBaseUrl: true });
   useEffect(() => {
     fetch(`${schemaRoot}/${props.event}.json`)
       .then((result) => result.json())