docs: move docs closer to code (#40)

Author: ilbertt

docs/.gitignore

@@ -1,4 +1,6 @@
 dist/
 src/content/tmp/
+src/content/docs/cli/
 src/content/docs/core/api/
+src/content/docs/plugins/vite/
 src/content/docs/changelog.md

docs/src/content/docs/_sidebar.json

@@ -13,13 +13,21 @@
         "items": [
           {
             "label": "Vite",
-            "link": "/plugins/vite"
+            "collapsed": true,
+            "autogenerate": {
+              "collapsed": true,
+              "directory": "plugins/vite"
+            }
           }
         ]
       },
       {
         "label": "CLI",
-        "link": "/cli"
+        "collapsed": true,
+        "autogenerate": {
+          "collapsed": true,
+          "directory": "cli"
+        }
       },
       {
         "label": "Library",

docs/src/content/docs/cli.md

@@ -1,6 +1,10 @@
 {
   "$schema": "https://typedoc-plugin-markdown.org/schema.json",
-  "entryPoints": ["../src/core/index.ts"],
+  "entryPoints": [
+    "../src/core/index.ts",
+    "../src/cli/icp-bindgen.ts",
+    "../src/plugins/vite.ts"
+  ],
   "tsconfig": "../tsconfig.json",
   "readme": "none",
   "out": "src/content/tmp",

docs/src/content/docs/plugins/vite.md

@@ -1,5 +1,53 @@
 #!/usr/bin/env node
 
+/**
+ * The CLI is used to generate bindings for a `.did` file.
+ *
+ * ## Installation
+ *
+ * As a dev dependency for your project:
+ *
+ * ```bash
+ * npm install -D @icp-sdk/bindgen
+ * ```
+ *
+ * Or as a global command:
+ *
+ * ```bash
+ * npm install -g @icp-sdk/bindgen
+ * ```
+ *
+ * ## Usage
+ *
+ * Suppose you have a `./canisters/hello_world.did` file, and you want to output the generated bindings for your Vite app in the `src/bindings/` folder.
+ *
+ * You can generate the bindings with the following command:
+ *
+ * ```bash
+ * icp-bindgen --did-file ./canisters/hello_world.did --out-dir ./src/bindings
+ * ```
+ *
+ * For an explanation of the generated files, see the [Bindings Structure](https://js.icp.build/bindgen/latest/structure/) page.
+ *
+ * ### Usage without installation
+ *
+ * ```bash
+ * npx @icp-sdk/bindgen --did-file ./canisters/hello_world.did --out-dir ./src/bindings
+ * ```
+ *
+ * ### Options
+ *
+ * - `--did-file <path>`: Path to the `.did` file to generate bindings from
+ * - `--out-dir <dir>`: Directory where the bindings will be written
+ * - `--actor-interface-file`: If set, generates a `<service-name>.d.ts` file that contains the same types of the `<service-name>.ts` file. Has no effect if `--actor-disabled` is set. (default: `false`)
+ * - `--actor-disabled`: If set, skips generating the actor file (`<service-name>.ts`). (default: `false`)
+ * - `--force`: If set, overwrite existing files instead of aborting. (default: `false`)
+ *
+ * > **Note**: The CLI does not support additional features yet.
+ *
+ * @module cli
+ */
+
 import { Command } from 'commander';
 import { BIN_NAME, PACKAGE_VERSION } from '../core/constants.ts';
 import { generate } from '../core/generate/index.ts';

docs/typedoc.json

@@ -1,3 +1,37 @@
+/**
+ * The Vite plugin is used to generate bindings for a `.did` file during the build process.
+ *
+ * ## Installation
+ *
+ * ```bash
+ * npm install -D @icp-sdk/bindgen
+ * ```
+ *
+ * ## Usage
+ *
+ * Suppose you have a `./canisters/hello_world.did` file, and you want to output the generated bindings for your Vite app in the `src/bindings/` folder.
+ * Here's how the plugin configuration would look like:
+ *
+ * ```ts title="vite.config.ts"
+ * import { defineConfig } from "vite";
+ * import { icpBindgen } from '@icp-sdk/bindgen/plugins/vite';
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     // ... other plugins
+ *     icpBindgen({
+ *       didFile: './canisters/hello_world.did',
+ *       outDir: './src/bindings',
+ *     }),
+ *   ],
+ * });
+ * ```
+ *
+ * For an explanation of the generated files, see the [Bindings Structure](https://js.icp.build/bindgen/latest/structure/) page.
+ *
+ * @module plugins/vite
+ */
+
 import { resolve } from 'node:path';
 import type { Plugin, ViteDevServer } from 'vite';
 import {
@@ -51,6 +85,8 @@ export interface Options extends Omit<GenerateOptions, 'output'> {
  *   ],
  * });
  * ```
+ *
+ * @ignore
  */
 export function icpBindgen(options: Options): Plugin {
   return {