starred/warmbly

mirror of https://github.com/warmbly/warmbly.git synced 2026-08-20 16:01:19 +00:00

Files

T

History

Matthew Meszaros 619f4fd9a1 feat: add a warmblyctl reference page at docs/content/docs/development/warmblyctl.mdx documenting all nine commands with every flag, because the README and the recovery sections only ever showed 'warmblyctl user create --email ... --admin' without saying where the password comes from, leaving self-hosters with an account they could not sign in to and no page that answered it, covering that user create prompts for the password twice on a terminal and refuses on a non-TTY unless --password-stdin is passed, that docker compose exec allocates the TTY those prompts need unless -T is given and piped input needs -T precisely because it removes it, that the password rule is the dashboard's own 8 to 128 characters, and that signing in afterwards needs nothing else on a stock self-host since AUTH_LOGIN_CODE defaults to off and REQUIRE_EMAIL_VERIFICATION to false when self-hosted, captcha stays off without TURNSTILE_SECRET, and --admin opens the panel on ADMIN_URL rather than APP_URL, plus the status JSON contract and exit codes, the four environment variables each command reads, the per-command behaviour when Redis is down, the admin role masks read from AdminRolePermissions, and the make wrappers, registering it in the Development meta.json between accounts-and-access and configuration, linking it from the four pages that already print these commands, correcting the super-admin mask in the first-run sample output from 4294967295 to the 4194303 that AllAdminPermissions actually is since it is (1 << 22) - 1 and not the full uint32 range, and shortening the README self-hosting section by folding the three-bullet gotcha list into a four-row table that also names make doctor and dropping the duplicated make dev claim warning already stated above it, keeping every fact (#128 )

2026-08-16 08:39:57 +02:00

..

docs: refresh the documentation site, fix inaccurate claims and contact addresses, add SEO primitives (#90 )

2026-08-05 10:37:27 +02:00

docs: reduce the top and bottom padding inside the logo svg from 40px to 16px each side

2026-07-22 09:03:12 +02:00

docs: refresh the documentation site, fix inaccurate claims and contact addresses, add SEO primitives (#90 )

2026-08-05 10:37:27 +02:00

feat: add a warmblyctl reference page at docs/content/docs/development/warmblyctl.mdx documenting all nine commands with every flag, because the README and the recovery sections only ever showed 'warmblyctl user create --email ... --admin' without saying where the password comes from, leaving self-hosters with an account they could not sign in to and no page that answered it, covering that user create prompts for the password twice on a terminal and refuses on a non-TTY unless --password-stdin is passed, that docker compose exec allocates the TTY those prompts need unless -T is given and piped input needs -T precisely because it removes it, that the password rule is the dashboard's own 8 to 128 characters, and that signing in afterwards needs nothing else on a stock self-host since AUTH_LOGIN_CODE defaults to off and REQUIRE_EMAIL_VERIFICATION to false when self-hosted, captcha stays off without TURNSTILE_SECRET, and --admin opens the panel on ADMIN_URL rather than APP_URL, plus the status JSON contract and exit codes, the four environment variables each command reads, the per-command behaviour when Redis is down, the admin role masks read from AdminRolePermissions, and the make wrappers, registering it in the Development meta.json between accounts-and-access and configuration, linking it from the four pages that already print these commands, correcting the super-admin mask in the first-run sample output from 4294967295 to the 4194303 that AllAdminPermissions actually is since it is (1 << 22) - 1 and not the full uint32 range, and shortening the README self-hosting section by folding the three-bullet gotcha list into a four-row table that also names make doctor and dropping the duplicated make dev claim warning already stated above it, keeping every fact (#128 )

2026-08-16 08:39:57 +02:00

feat: rebrand the docs app with the warmbly theme and nav, wire copy-markdown page actions, add a custom 404 and a root redirect to guides, and make the build a fully static export with trailing-slash urls

2026-06-10 18:26:55 +02:00

feat: restyle the docs site without decorative sidebar icons (frontmatter icons dropped, lucide source plugin disabled, AGENTS.md conventions updated), add LangTab language-logo code tabs, and document the new agent tools plus panel resize/placement/shortcuts in the assistant guide and MCP reference

2026-07-16 07:50:24 +02:00

docs: refresh the documentation site, fix inaccurate claims and contact addresses, add SEO primitives (#90 )

2026-08-05 10:37:27 +02:00

.gitignore

Docs using Fumadocs

2026-01-30 18:07:06 +01:00

eslint.config.mjs

Docs using Fumadocs

2026-01-30 18:07:06 +01:00

mdx-components.tsx

feat: make self-hosting work end to end and rewrite the guide around what was tested (#97 )

2026-08-13 09:47:46 +02:00

next.config.mjs

feat: shorten verbose code comments in the docs app and add a one-line comment rule to the agent notes

2026-06-10 18:36:29 +02:00

package.json

docs: refresh the documentation site, fix inaccurate claims and contact addresses, add SEO primitives (#90 )

2026-08-05 10:37:27 +02:00

pnpm-lock.yaml

feat: make self-hosting work end to end and rewrite the guide around what was tested (#97 )

2026-08-13 09:47:46 +02:00

pnpm-workspace.yaml

feat: make self-hosting work end to end and rewrite the guide around what was tested (#97 )

2026-08-13 09:47:46 +02:00

postcss.config.mjs

Docs using Fumadocs

2026-01-30 18:07:06 +01:00

README.md

feat: rebrand the docs app with the warmbly theme and nav, wire copy-markdown page actions, add a custom 404 and a root redirect to guides, and make the build a fully static export with trailing-slash urls

2026-06-10 18:26:55 +02:00

source.config.ts

Docs using Fumadocs

2026-01-30 18:07:06 +01:00

tsconfig.json

Docs using Fumadocs

2026-01-30 18:07:06 +01:00

README.md

Warmbly docs

The documentation site served at docs.warmbly.com, built with Next.js and Fumadocs. Content lives in content/docs/ as MDX, split into three sidebar sections:

guides/: how every part of the product works
learn/: cold email and deliverability fundamentals
api/: API reference (authentication, permissions, endpoints, error codes)

Development

pnpm install
pnpm dev          # dev server on :3000
pnpm types:check  # mdx + route types + tsc
pnpm lint         # eslint

Static export

pnpm build writes the entire site to out/ as a fully static export, servable from any static host or CDN. Search runs client-side from a prebuilt index (/api/search), OG images are generated at build time, and every page has a raw-Markdown mirror under /llms.mdx/docs/ plus llms.txt / llms-full.txt indexes.

Serving notes: the export uses trailing-slash URLs (guides/mailboxes/index.html), and the custom 404 page is emitted as 404.html. Configure your host to serve it for unknown paths.

Conventions

Frontmatter title is the page H1; do not repeat it as a # heading in the body. Set a lucide icon per page via the icon field.
A folder becomes a sidebar tab when its meta.json sets "root": true.
Avoid em dashes in prose; use a period, comma, colon, or parentheses.