update readme

Author: YousefED

CONTRIBUTING.md

@@ -1,8 +1,23 @@
 # Development
 
-We use [Lerna](https://lerna.js.org/) to manage the monorepo with separate packages. In VS Code, it's best to open `typecell.code-workspace` to open the project as a workspace.
+TypeCell is a monorepo containing several packages. In VS Code, it's best to open `typecell.code-workspace` to open the project as a workspace.
 
-## Running
+## Directory structure:
+
+```
+blocknote
+├── docs                - Docs / samples (see https://www.typecell.org/docs/)
+├── packages
+│   ├── common          - Utility functions shared across the codebase
+│   ├── editor          - The main React application
+│   ├── engine          - The live-code execution engine
+│   ├── packager        - Tool to bundle TypeCell notebook apps (WIP)
+│   └── parsers         - Helpers to convert to / from TypeCell notebooks
+├── patches             - patch-package patches
+└── test-util           - Server and data for unit tests
+```
+
+## Running locally
 
 Node.js is required to run this project. To download Node.js, visit [nodejs.org](https://nodejs.org/en/).
 
@@ -17,8 +32,14 @@ To run the project, open the command line in the project's root directory and en
     # Start the main editor project
     npm start
 
+The above `npm start` executes the `vite dev` command of `packages/editor` and watches for changes to this main package.
+
 ## Watch changes
 
     npm run watch
 
-The above `npm start` executes the `vite dev` command of `packages/editor` and watches for changes to this main package. However, you might also be making changes to other packages in the `packages` directory. To continuously watch and compile for changes, open a new terminal and run `npm run watch`.
+You might also be making changes to other packages in the `packages` directory. To continuously watch and compile for changes, open a new terminal and run `npm run watch`.
+
+## Testing
+
+The codebase is automatically tested using Vitest and Playwright. When submitting a PR or issue, ideally try to add a test case for it.

README.md

@@ -12,9 +12,54 @@ Welcome to TypeCell! An open source live programming environment. Together, we w
 <a href="https://discord.gg/aDQxXezfNj"><img alt="Discord" src="https://img.shields.io/badge/Chat on discord%20-%237289DA.svg?&style=for-the-badge&logo=discord&logoColor=white"/></a> <a href="https://matrix.to/#/#typecell-space:matrix.org"><img alt="Matrix" src="https://img.shields.io/badge/Chat on matrix%20-%23000.svg?&style=for-the-badge&logo=matrix&logoColor=white"/></a>
 </p>
 
-## Contributing 🙌
+<p align="center">
+  <a href="https://www.typecell.org">
+    <img alt="TypeCell demo" src="./packages/editor/src/app/main/components/startscreen/assets/intro.gif?raw=true" width="600" />
+  </a>
+</p>
+
+# Features
+
+- Open Source, cell-based notebook environment
+- Same, powerful editing experience as VS Code
+- 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
+
+[Try the Tutorial to get started!](https://www.typecell.org/docs/interactive-introduction.md)
+
+# Documentation 📖
+
+## Tutorial
+
+Complete the tutorial to get familiar with TypeCell:
+
+» [Interactive introduction](https://www.typecell.org/docs/interactive-introduction.md)
+
+## Manual
+
+We've written about the main functionality of TypeCell in the [manual](https://www.typecell.org/docs/manual):
+
+- [Notebooks and cells](https://www.typecell.org/docs/manual/1.%20Notebooks%20and%20cells.md)
+- [TypeScript and exports](https://www.typecell.org/docs/manual/2.%20TypeScript%20and%20exports.md)
+- [Reactive variables](https://www.typecell.org/docs/manual/3.%20Reactive%20variables.md)
+- [Working with user input](https://www.typecell.org/docs/manual/4.%20Inputs.md)
+- [Imports & NPM](https://www.typecell.org/docs/manual/5.%20Imports%20and%20NPM.md)
+- [Collaboration](https://www.typecell.org/docs/manual/6.%20Collaboration.md)
+
+## Demos
+
+Another good way to learn is to check out some notebooks from our community:
+
+» [View demo notebooks](/docs/demos.md)
+
+# Feedback 🙋‍♂️🙋‍♀️
+
+We'd love to hear your thoughts and see your experiments, so [come and say hi on Discord](https://discord.gg/TcJ9TRC3SV) or [Matrix](https://matrix.to/#/#typecell-space:matrix.org).
+
+# Contributing 🙌
 
-See [CONTRIBUTING.md](CONTRIBUTING.md).
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more info and guidance on how to run the project (TLDR: just use `npm start`).
 
 TypeCell is organised as a monorepo containing several packages. Directory structure: