Add docs

hiroki0525 · Nov 22, 2023 · 26bfa34 · 26bfa34
1 parent f3216a6
commit 26bfa34
Show file tree

Hide file tree

Showing 13 changed files with 217 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,55 @@
 # Dandori（段取り）
 
-<img src="./media/dandori.png" alt="dandori" width="206" height="206">
+<img src="./media/dandori.png" alt="dandori" width="206">
 
-*This project is experimental.*
+*This project is experimental.*
+
+Dandori analyzes and visualizes the dependencies of your tasks.
+
+Let's look at a few examples.
+
+## Example 1
+
+### Input
+
+```text
+Today's My Tasks
+* Send Email to John
+* Send Email to Mary
+* Report to Boss after sending emails
+```
+
+### Output（Miro）
+
+<img src="./media/miro_example.png" alt="miro output example" width="422">
+
+## Example 2
+
+### Input
+
+```text
+Today's My Tasks
+* [todo] Send Email to John
+* [doing] Write a blog
+* [done] Report to Boss
+```
+
+### Output（Notion）
+
+<img src="./media/notion_example.png" alt="notion output example" width="426">
+
+## Usage
+
+This project is monorepo. You can choose the following ways to use it.
+
+### Use CLI
+
+Please read [`@dandori/cli` README](./packages/cli/README.md).
+
+### Use your own code
+
+Please read [`@dandori/core` README](./packages/core/README.md) and [`@dandori/ui` README](./packages/ui/README.md).
+
+### License
+
+Released under the MIT license.
diff --git a/media/miro_example.png b/media/miro_example.png
diff --git a/media/notion_example.png b/media/notion_example.png
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -1,3 +1,51 @@
 # dandori/cli
 
-*This project is experimental.*
+This repository is responsible for executing `@dandori/*` packages.
+
+## Installation
+
+```bash
+# It isn't necessary to install this package if you use the command like `npx` .
+npm install @dandori/cli
+yarn add @dandori/cli
+pnpm add @dandori/cli
+```
+
+## Usage
+
+First, please create `.env` file and set environment variables like below.
+
+```text
+OPENAI_API_KEY=your_openai_api_key
+MIRO_API_KEY=your_miro_api_key
+```
+
+Second, 
+
+```ts
+import generateDandoriTasks from '@dandori/core';
+import { generateDandoriMiroCards } from "@dandori/ui";
+
+const text = `
+Today's My Tasks
+* Send Email to John
+* Send Email to Mary
+* Report to Boss after sending emails
+`;
+
+const tasks = await generateDandoriTasks(text);
+await generateDandoriMiroCards(tasks, {
+  boardId: '1234567890',
+});
+```
+
+## Requirements
+
+* Please see [`@dandori/core` README]('../core/README.md') before using `@dandori/ui`.
+* `@dandori/ui` depends on external APIs. You need to set `EXTERNALAPP_API_KEY` environment variables like `MIRO_API_KEY` .
+* `@dandori/ui` supports to load `.env` file. Please create `.env` file and set environment variables.
+
+## Supported External APIs
+
+* [Miro](https://miro.com/)
+* [Notion](https://www.notion.so/)
diff --git a/packages/cli/src/core/index.ts b/packages/cli/src/core/index.ts
@@ -25,6 +25,7 @@ const supportedOptionalTaskProps: OptionalTaskPropsOption = [
   "description",
   "deadline",
   "assignee",
+  "status",
   "all",
 ];
 

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -1,3 +1,31 @@
 # dandori/core
 
-*This project is experimental.*
+This repository is responsible for generating the task dependency from texts by using AI.
+
+## Installation
+
+```bash
+npm install @dandori/core
+yarn add @dandori/core
+pnpm add @dandori/core
+```
+
+## Usage
+
+```ts
+import generateDandoriTasks from '@dandori/core';
+
+const texts = `
+Today's My Tasks
+* Send Email to John
+* Send Email to Mary
+* Report to Boss after sending emails
+`;
+
+const tasks = await generateDandoriTasks(texts);
+```
+
+## Requirements
+
+* `@dandori/core` depends on OpenAI API. You need to set `OPENAI_API_KEY` environment variable.
+* `@dandori/core` supports to load `.env` file. Please create `.env` file and set `OPENAI_API_KEY` environment variable.
diff --git a/packages/libs/README.md b/packages/libs/README.md
@@ -1,3 +1,5 @@
-# dandori/ui
+# dandori/libs
 
-*This project is experimental.*
+This repository is responsible for defining common logics for `@dandori/*` packages.
+
+In most cases, you don't need to use this package directly.
diff --git a/packages/ui/README.md b/packages/ui/README.md
@@ -1,3 +1,41 @@
 # dandori/ui
 
-*This project is experimental.*
+This repository is responsible for viewing your tasks which are generated by `@dandori/core` .
+
+## Installation
+
+```bash
+npm install @dandori/core @dandori/ui
+yarn add @dandori/core @dandori/ui
+pnpm add @dandori/core @dandori/ui
+```
+
+## Usage
+
+```ts
+import generateDandoriTasks from '@dandori/core';
+import { generateDandoriMiroCards } from "@dandori/ui";
+
+const text = `
+Today's My Tasks
+* Send Email to John
+* Send Email to Mary
+* Report to Boss after sending emails
+`;
+
+const tasks = await generateDandoriTasks(text);
+await generateDandoriMiroCards(tasks, {
+  boardId: '1234567890',
+});
+```
+
+## Requirements
+
+* Please see [`@dandori/core` README]('../core/README.md') before using `@dandori/ui`.
+* `@dandori/ui` depends on external APIs. You need to set `EXTERNALAPP_API_KEY` environment variables like `MIRO_API_KEY` .
+* `@dandori/ui` supports to load `.env` file. Please create `.env` file and set environment variables.
+
+## Supported External APIs
+
+* [Miro](https://miro.com/)
+* [Notion](https://www.notion.so/)
diff --git a/packages/ui/global.d.ts b/packages/ui/global.d.ts
@@ -2,8 +2,8 @@ declare module "process" {
   global {
     namespace NodeJS {
       interface ProcessEnv {
-        MIRO_ACCESS_TOKEN: string;
-        NOTION_TOKEN: string;
+        MIRO_API_KEY: string;
+        NOTION_API_KEY: string;
       }
     }
   }

diff --git a/packages/ui/src/__tests__/notion.test.ts b/packages/ui/src/__tests__/notion.test.ts
@@ -94,7 +94,7 @@ describe("generateDandoriNotionPages", () => {
   };
 
   beforeAll(() => {
-    process.env.NOTION_TOKEN = "token";
+    process.env.NOTION_API_KEY = "token";
   });
 
   beforeEach(() => {

diff --git a/packages/ui/src/miro.ts b/packages/ui/src/miro.ts
@@ -55,7 +55,7 @@ export async function generateDandoriMiroCards(
 ): Promise<void> {
   const logger = getLogger();
   const miroApi = new MiroApi(
-    process.env.MIRO_ACCESS_TOKEN,
+    process.env.MIRO_API_KEY,
     undefined,
     (...thing) => {
       logger.debug(thing);

diff --git a/packages/ui/src/notion.ts b/packages/ui/src/notion.ts
@@ -86,7 +86,7 @@ const createPageParams = (
       ],
     },
   };
-  if (descriptionProp) {
+  if (description && descriptionProp) {
     pageProperties[descriptionProp] = {
       rich_text: [
         {
@@ -134,7 +134,7 @@ export async function generateDandoriNotionPages(
 ): Promise<void> {
   const logger = getLogger();
   const client = new Client({
-    auth: process.env.NOTION_TOKEN,
+    auth: process.env.NOTION_API_KEY,
     logger: (
       level: LogLevel,
       message: string,

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml