update docs

YousefED · YousefED · commit eead5f1f1f6a · 2022-12-01T17:27:30.000+01:00
diff --git a/LICENSE.md b/LICENSE.md
diff --git a/README.md b/README.md
@@ -25,6 +25,8 @@ Welcome to TypeCell! An open source live programming environment. Together, we w
 - Full TypeScript support! (no weird custom language constructs)
 - Reactive Runtime, cells automatically re-evaluate when their dependencies update ([learn more](https://www.typecell.org/docs/manual/3.%20Reactive%20variables.md))
 - Import NPM packages + types just by writing an `import` statement
+- Support for real-time collaboration (using [Yjs](https://github.com/yjs/yjs))
+- Runs on top of [Matrix](https://www.matrix.org) using [Matrix-CRDT](https://github.com/yousefed/matrix-crdt).
 
 [Try the Tutorial to get started!](https://www.typecell.org/docs/interactive-introduction.md)
 
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "root",
   "private": true,
-  "license": "AGPL",
+  "license": "AGPL-3.0",
   "devDependencies": {
     "lerna": "^5.0.0",
     "playwright": "^1.18.1",
diff --git a/packages/common/README.md b/packages/common/README.md
@@ -0,0 +1,3 @@
+# packages/common
+
+Just some helper functions used across the codebase exported as `@typecell-org/common`.
diff --git a/packages/editor/README.md b/packages/editor/README.md
@@ -0,0 +1,5 @@
+# packages/editor
+
+The main application / website of TypeCell.
+
+TODO: explain architecture, directories, etc.
diff --git a/packages/engine/README.md b/packages/engine/README.md
@@ -0,0 +1,13 @@
+# packages/engine
+
+The Reactive Runtime responsible for evaluating user cells, exported as `@typecell-org/engine`.
+
+## Engine
+
+The TypeCell Reactive Runtime is built on top of MobX.
+
+The engine (`Engine.ts`) automatically runs models registered to it. The code of the models is passed an observable context ($) provided by the engine. This context is how the code of different models can react to each other.
+
+## Resolvers
+
+The `src/resolver` directory contains the logic to load third party NPM modules using esm.sh (or fallback to skypack / jspm).
diff --git a/packages/engine/src/README.md b/packages/engine/src/README.md
diff --git a/packages/engine/src/executor.ts b/packages/engine/src/executor.ts
@@ -2,7 +2,6 @@ import { autorun, runInAction } from "mobx";
 import { TypeCellContext } from "./context.js";
 import { installHooks } from "./hookDisposables.js";
 import { Module } from "./modules.js";
-import { isStored } from "./storage/stored.js";
 import { isView } from "./view.js";
 
 async function resolveDependencyArray(
@@ -141,11 +140,7 @@ export async function runModule(
 
           const saveValue = (exported: any) => {
             if (propertyName !== "default") {
-              if (isStored(exported)) {
-                // context.storage.addStoredValue(propertyName, exported);
-              } else {
-                context.rawContext[propertyName] = exported;
-              }
+              context.rawContext[propertyName] = exported;
             }
           };
 
diff --git a/packages/engine/src/storage/Storage.ts b/packages/engine/src/storage/Storage.ts
diff --git a/packages/engine/src/storage/stored.ts b/packages/engine/src/storage/stored.ts
diff --git a/packages/packager/README.md b/packages/packager/README.md
@@ -1,4 +1,3 @@
-### TODO:
+# packages/packager
 
-- template: remove react dependency?
-- template: share duplicated components code (from editor)?
+WIP: this can create a working Vite app from your TypeCell notebooks.
diff --git a/packages/packager/template/src/App.tsx b/packages/packager/template/src/App.tsx
@@ -1,3 +1,4 @@
+// TODO: should be extracted from packages/editor?
 import Output from "./components/Output";
 import * as notebook from "./notebook";
 
diff --git a/packages/packager/template/src/main.tsx b/packages/packager/template/src/main.tsx
@@ -3,6 +3,7 @@ import { createRoot } from "react-dom/client";
 import App from "./App";
 // import "./index.css";
 
+// TODO: we might want to remove the explicit React dependency in the template
 const root = createRoot(document.getElementById("root")!);
 root.render(
   <React.StrictMode>
diff --git a/packages/parsers/README.md b/packages/parsers/README.md
@@ -0,0 +1,40 @@
+# packages/parsers
+
+Helper functions to convert to and from different file formats, exported as `@typecell-org/parsers`.
+
+## TypeCell document format
+
+A TypeCell document is represented like an array of cells:
+
+```typescript
+export type Document = {
+  cells: Array<Cell>;
+};
+
+export type Cell = {
+  language: Language;
+  code: string;
+  id?: string;
+};
+```
+
+## Markdown parser
+
+The Markdown parser can read Markdown files and convert this to the TypeCell document format, or export from TypeCell to Markdown.
+
+Let's say we have the following `.md` file:
+
+<pre>
+# Title
+
+This is an example introductory paragraph. Below is a live-code TypeCell cell:
+
+```typescript
+export let str = "hello world";
+```
+</pre>
+
+The markdown parser would parse this to a document containing two cells:
+
+- one cell with `language: "markdown"` (containing the title and first paragraph).
+- and one cell with `language: "typescript"` containing the typescript code.

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "root",`
`3`	`3`	`"private": true,`
`4`		`- "license": "AGPL",`
	`4`	`+ "license": "AGPL-3.0",`
`5`	`5`	`"devDependencies": {`
`6`	`6`	`"lerna": "^5.0.0",`
`7`	`7`	`"playwright": "^1.18.1",`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# packages/common`
	`2`	`+`
	`3`	+Just some helper functions used across the codebase exported as `@typecell-org/common`.