diff --git a/docs/code_design.md b/docs/code_design.md new file mode 100644 index 0000000..7a8df80 --- /dev/null +++ b/docs/code_design.md @@ -0,0 +1,13 @@ +# Code Design + +## Code Organization + +1. Every function except `main.ts` should be pure. Pass any stateful information in parameters. + +2. `misc.ts` should not depend on any other written code. + +3. Each storage code should not depend on `sync.ts`. + +## File and Folder Representation + +While writing sync codes, folders are always represented by a string ending with `/`.