SalescalingDocs
DemoApp

Desarrollo de Salescaling Docs

Documentación técnica del paquete apps/docs.

Desarrollo local

bash
pnpm --filter docs dev

La app corre en http://localhost:3003.

Variables de entorno

VariableDescripción
NEXT_PUBLIC_DOCS_SITE_URLURL pública del sitio (p. ej. https://docs.salescaling.com). Usada para canonical, sitemap y Open Graph.
DOCS_NOINDEXSi es true, desactiva indexación (noindex, nofollow) y el sitemap. Usar en staging.
NEXT_PUBLIC_API_BASE_URLBase URL del API para el playground Try-it.
NEXT_PUBLIC_OPENAPI_URLURL del spec OpenAPI para la referencia API.
OPENAI_API_KEYClave para búsqueda con IA (/api/docs/ask).
DOCS_ASK_RATE_LIMITLímite de peticiones/minuto para ask (default: 20).
DOCS_TRY_IT_RATE_LIMITLímite de peticiones/minuto para try-it (default: 30).

Producción

bash
NEXT_PUBLIC_DOCS_SITE_URL=https://docs.salescaling.com

Staging

bash
NEXT_PUBLIC_DOCS_SITE_URL=https://docs-staging.salescaling.com
DOCS_NOINDEX=true

Además, proteger staging con autenticación en la capa de infraestructura.

SEO

  • robots.txt y sitemap.xml se generan automáticamente.
  • Las URLs cortas (aliases) se definen en config/url-aliases.json.
  • Las páginas publicadas usan index, follow con canonical autorreferencial.
  • Añade description en el frontmatter YAML de cada guía prioritaria.

Tests

bash
pnpm --filter docs test