From 7e5e87ab4738f0435f432c7b1c3296ae6d678f12 Mon Sep 17 00:00:00 2001
From: Nemo <nemo@daangn.com>
Date: Mon, 19 Feb 2024 17:39:11 +0900
Subject: [PATCH] docs: graph workflow

---
 graph/mod.ts | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/graph/mod.ts b/graph/mod.ts
index 9bc03f1..a3844fb 100644
--- a/graph/mod.ts
+++ b/graph/mod.ts
@@ -1,3 +1,47 @@
+// deno-lint-ignore-file no-unused-vars
+import type { getDecls } from "./decls.ts"
+import type { DeclDeps, getDeclDeps } from "./decl_deps.ts"
+import type { declDepsToGraph, Graph } from "./graph.ts"
+import type { graphToTopDeclDeps, TopDeclDeps } from "./top_decl_deps.ts"
+
+/**
+ * @module
+ *
+ * ## `stackgraph/graph` Workflow
+ *
+ * ### Terminology
+ *
+ * - `decl`: top-level declaration (variable, function, class)
+ * - `deps`: reference to another `decl`
+ * - `decl deps`: Map of `decl` and its `deps`
+ * - `graph`: directed graph made with `decl deps`
+ * - `top decl deps`:
+ *   - inversed `graph` folded into record
+ *   - with leaf `decl` as keys
+ *   - and all path `decl` as values
+ *
+ * ### Getting `decl`s
+ *
+ * 1. get all declarations from source file
+ * 2. filter out decl entrypoints with {@link getDecls}
+ *
+ * ### Getting `decl deps`
+ *
+ * using {@link getDeclDeps}:
+ *
+ * 1. search all deps from each decl
+ * 2. for each deps, do step 1
+ * 3. collect them into {@link DeclDeps}
+ *
+ * ### Getting `graph`
+ *
+ * generate {@link Graph} using {@link declDepsToGraph}
+ *
+ * ### Getting `top decl deps`
+ *
+ * generate {@link TopDeclDeps} using {@link graphToTopDeclDeps}
+ */
+
 export * from "./decls.ts"
 
 export * from "./decl_deps.ts"