-[](https://conventionalcommits.org)  [](https://openbase.com/js/patronum?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge)
+[](https://conventionalcommits.org) 
[](/LICENSE)
[](https://github.com/effector/patronum)
[](https://npmjs.com/package/patronum)
@@ -16,7 +16,7 @@
[codesandbox]: https://codesandbox.io/s/effector-patronum-playground-zuqjx
[try-patronum-share]: https://share.effector.dev/Neewtbz3
[jsdelivr]: https://www.jsdelivr.com/package/npm/patronum
-[unpkg]: https://unpkg.com/browse/patronum@1.7.0/
+[unpkg]: https://unpkg.com/browse/patronum@2/
[npm]: https://www.npmjs.com/package/patronum
[github]: https://github.com/effector/patronum
[twitter-share]: https://twitter.com/intent/tweet?text=I%20used%20patronum!%0AGoing%20to%20Mars%20with%20%40effectorjs%20-%20data-flow%20powered%20tool%20to%20implement%20business%20logic.%0A%0Ahttps%3A%2F%2Fgithub.com%2Feffector%2Fpatronum%0A
@@ -44,13 +44,13 @@ const userLoadFx = createEffect();
const $status = status({ effect: userLoadFx });
```
-You can read more at [documentation](https://patronum.effector.dev/docs/installation).
+You can read more at [documentation](https://patronum.effector.dev/guides/installation/).
## Migration guide
Patronum had 3 breaking changes: 1) from `0.14` to `0.100`, 2) from `0.100` to `0.110`, 3) from `0.110` to `1.0`
-We have [migration guide](https://patronum.effector.dev/docs/migration-guide).
+We have [migration guide](https://patronum.effector.dev/guides/migration).
# Development
diff --git a/documentation/.gitignore b/documentation/.gitignore
new file mode 100644
index 00000000..6240da8b
--- /dev/null
+++ b/documentation/.gitignore
@@ -0,0 +1,21 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
diff --git a/documentation/.prettierrc.mjs b/documentation/.prettierrc.mjs
new file mode 100644
index 00000000..d9e6bad6
--- /dev/null
+++ b/documentation/.prettierrc.mjs
@@ -0,0 +1,17 @@
+/** @type {import("prettier").Config} */
+export default {
+ arrowParens: 'always',
+ printWidth: 120,
+ trailingComma: 'all',
+ singleQuote: true,
+ jsxSingleQuote: true,
+ plugins: ['prettier-plugin-astro'],
+ overrides: [
+ {
+ files: '*.astro',
+ options: {
+ parser: 'astro',
+ },
+ },
+ ],
+};
diff --git a/documentation/.vscode/extensions.json b/documentation/.vscode/extensions.json
new file mode 100644
index 00000000..22a15055
--- /dev/null
+++ b/documentation/.vscode/extensions.json
@@ -0,0 +1,4 @@
+{
+ "recommendations": ["astro-build.astro-vscode"],
+ "unwantedRecommendations": []
+}
diff --git a/documentation/.vscode/launch.json b/documentation/.vscode/launch.json
new file mode 100644
index 00000000..d6422097
--- /dev/null
+++ b/documentation/.vscode/launch.json
@@ -0,0 +1,11 @@
+{
+ "version": "0.2.0",
+ "configurations": [
+ {
+ "command": "./node_modules/.bin/astro dev",
+ "name": "Development server",
+ "request": "launch",
+ "type": "node-terminal"
+ }
+ ]
+}
diff --git a/documentation/README.md b/documentation/README.md
new file mode 100644
index 00000000..e09bf55f
--- /dev/null
+++ b/documentation/README.md
@@ -0,0 +1,55 @@
+# Starlight Starter Kit: Basics
+
+[](https://starlight.astro.build)
+
+```
+npm create astro@latest -- --template starlight
+```
+
+[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
+[](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
+[](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
+[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
+
+> π§βπ **Seasoned astronaut?** Delete this file. Have fun!
+
+## π Project Structure
+
+Inside of your Astro + Starlight project, you'll see the following folders and files:
+
+```
+.
+βββ public/
+βββ src/
+β βββ assets/
+β βββ content/
+β β βββ docs/
+β β βββ config.ts
+β βββ env.d.ts
+βββ astro.config.mjs
+βββ package.json
+βββ tsconfig.json
+```
+
+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
+
+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+
+Static assets, like favicons, can be placed in the `public/` directory.
+
+## π§ Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command | Action |
+| :------------------------ | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:4321` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI |
+
+## π Want to learn more?
+
+Check out [Starlightβs docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
diff --git a/documentation/astro.config.mjs b/documentation/astro.config.mjs
new file mode 100644
index 00000000..d73b68f0
--- /dev/null
+++ b/documentation/astro.config.mjs
@@ -0,0 +1,45 @@
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+
+// https://astro.build/config
+export default defineConfig({
+ site: 'https://patronum.effector.dev',
+ integrations: [
+ starlight({
+ title: 'effector patronum β¨',
+ description: 'Operators library delivering modularity and convenience.',
+ logo: {
+ src: './src/assets/comet.png',
+ },
+ editLink: {
+ baseUrl: 'https://github.com/effector/patronum/edit/main/documentation',
+ },
+ social: {
+ github: 'https://github.com/effector/patronum',
+ telegram: 'https://t.me/effector_en',
+ 'x.com': 'https://x.com/effectorjs',
+ reddit: 'https://www.reddit.com/r/effectorjs/',
+ discord: 'https://discord.gg/yHcMcuRWeC',
+ youtube: 'https://youtube.com/@effectorjs',
+ },
+ sidebar: [
+ {
+ label: 'Guides',
+ autogenerate: { directory: 'guides' },
+ },
+ {
+ label: 'Reference',
+ items: [
+ {
+ label: 'Operators',
+ link: '/operators',
+ },
+ ],
+ },
+ ],
+ }),
+ ],
+ experimental: {
+ contentLayer: true,
+ },
+});
diff --git a/documentation/package.json b/documentation/package.json
new file mode 100644
index 00000000..9b9d27f1
--- /dev/null
+++ b/documentation/package.json
@@ -0,0 +1,26 @@
+{
+ "name": "documentation",
+ "type": "module",
+ "version": "0.0.1",
+ "scripts": {
+ "dev": "astro dev",
+ "start": "astro dev",
+ "sync": "astro sync",
+ "preview": "astro preview",
+ "build": "astro check && astro build",
+ "astro": "astro",
+ "format": "prettier --write ."
+ },
+ "dependencies": {
+ "@astrojs/check": "^0.9.3",
+ "@astrojs/starlight": "^0.26.1",
+ "astro": "^4.15.1",
+ "sharp": "^0.32.5",
+ "starlight-package-managers": "^0.6.0",
+ "typescript": "^5.5.4"
+ },
+ "devDependencies": {
+ "prettier": "^3.3.3",
+ "prettier-plugin-astro": "^0.14.1"
+ }
+}
diff --git a/website/static/.nojekyll b/documentation/public/.nojekyll
similarity index 100%
rename from website/static/.nojekyll
rename to documentation/public/.nojekyll
diff --git a/website/static/img/favicon.ico b/documentation/public/favicon.ico
similarity index 100%
rename from website/static/img/favicon.ico
rename to documentation/public/favicon.ico
diff --git a/documentation/public/favicon.svg b/documentation/public/favicon.svg
new file mode 100644
index 00000000..1ac71216
--- /dev/null
+++ b/documentation/public/favicon.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/documentation/public/robots.txt b/documentation/public/robots.txt
new file mode 100644
index 00000000..618fc0d9
--- /dev/null
+++ b/documentation/public/robots.txt
@@ -0,0 +1,4 @@
+User-agent: *
+Allow: /
+
+Sitemap: https://effector.patronum.dev/sitemap-index.xml
diff --git a/website/static/img/comet.png b/documentation/src/assets/comet.png
similarity index 100%
rename from website/static/img/comet.png
rename to documentation/src/assets/comet.png
diff --git a/documentation/src/assets/houston.webp b/documentation/src/assets/houston.webp
new file mode 100644
index 00000000..930c1649
Binary files /dev/null and b/documentation/src/assets/houston.webp differ
diff --git a/documentation/src/content/config.ts b/documentation/src/content/config.ts
new file mode 100644
index 00000000..06a83f9c
--- /dev/null
+++ b/documentation/src/content/config.ts
@@ -0,0 +1,27 @@
+import { defineCollection, z } from 'astro:content';
+import { docsSchema } from '@astrojs/starlight/schema';
+import { glob } from 'astro/loaders';
+
+const operators = defineCollection({
+ type: 'content_layer',
+ loader: glob({ pattern: '*/*.md', base: '../src' }),
+ schema: z.object({
+ title: z.string(),
+ description: z.string().optional(),
+ slug: z.string(),
+ group: z.enum(['predicate', 'effect', 'timeouts', 'combination', 'debug']),
+ badge: z
+ .object({
+ variant: z
+ .enum(['note', 'danger', 'success', 'caution', 'tip', 'default'])
+ .default('default'),
+ text: z.string(),
+ })
+ .optional(),
+ }),
+});
+
+export const collections = {
+ docs: defineCollection({ schema: docsSchema() }),
+ operators,
+};
diff --git a/documentation/src/content/docs/guides/installation.mdx b/documentation/src/content/docs/guides/installation.mdx
new file mode 100644
index 00000000..48e1cf0c
--- /dev/null
+++ b/documentation/src/content/docs/guides/installation.mdx
@@ -0,0 +1,65 @@
+---
+title: Installation
+description: A guide how to use effector with patronum.
+---
+
+import { PackageManagers } from 'starlight-package-managers';
+
++ Redirecting to /operators/{operator.data.slug} +
+