snapshot of https://github.com/toeverything/AFFiNE.git (canary, 2026-09-16; blobs > 131072B omitted)

packages/frontend/routes/README.md

@@ -0,0 +1,38 @@
+# Routes
+
+## Usage
+
+### Path Factories
+
+```ts
+import { FACTORIES } from '@affine/routes';
+
+const path = FACTORIES.workspace.doc({ workspaceId: '123', docId: '456' });
+//                                     ^^^^ with typecheck
+```
+
+### Register router
+
+```tsx
+import { ROUTES } from '@affine/routes';
+
+function Routes() {
+  return <Router path={ROUTES.admin.index} element={} />;
+}
+```
+
+### Path Parameter
+
+```ts
+import { RouteParamsTypes } from '@affine/routes';
+
+function Doc() {
+  const { workspaceId, docId } =
+    useParams<RouteParamsTypes['workspace']['doc']>();
+}
+
+function Attachment() {
+  const { workspaceId, docId, attachmentId } =
+    useParams<RouteParamsTypes['workspace']['doc']['attachment']>();
+}
+```