Skip to content

README.md

Latest commit

 

History

History
79 lines (61 loc) · 3.1 KB

README.md

File metadata and controls

79 lines (61 loc) · 3.1 KB
Raw

ActionRail documentation site

The public documentation for ActionRail, an open-source project by ToolJet, is a Docusaurus 3 site kept in the ActionRail repository.

Local development

Requirements:

  • Node.js 20 or newer (.nvmrc selects Node 22)
  • npm
cd docs
npm ci
npm start

Docusaurus prints the local URL after compilation.

Production build

cd docs
npm run build

The static site is written to docs/build/. Broken internal links and broken Markdown links fail the build.

Deployment variables

Variable Default Purpose
DOCS_URL https://actionrail.ai Canonical site origin.
DOCS_BASE_URL / Deployment base path.
DOCS_ALGOLIA_APP_ID unset Algolia application ID.
DOCS_ALGOLIA_API_KEY unset Public search-only API key.
DOCS_ALGOLIA_INDEX_NAME unset Algolia DocSearch index.
DOCS_CLOUD_ACCESS_FORM_URL unset HTTPS endpoint that accepts cloud early-access form submissions as JSON.
DOCS_CLOUD_ACCESS_EMAIL hello@tooljet.com Email fallback used when no form endpoint is configured or a submission fails.
DOCS_GA_TRACKING_ID unset GA4 Measurement ID. Analytics and the consent controls are omitted when unset.

Search is added to the navigation only when all three Algolia variables are present. Configure them as GitHub Actions repository variables before the public launch. DOCS_ALGOLIA_API_KEY must be the public search-only key; never use an Algolia admin key in a documentation deployment.

The cloud access form sends name, email, company, use_case, a static source identifier, the displayed privacy-notice version, and an empty honeypot. Its endpoint must accept cross-origin JSON POST requests. When no endpoint is configured, the form clearly opens a prefilled email request instead of showing a false success state.

Website analytics is deliberately independent from anonymous Console and SDK telemetry. The Google tag is loaded only after an explicit analytics choice, and the site sends only page views and allowlisted launch events. Advertising storage, advertising personalization, and Google Signals remain disabled.

The repository deploys docs/build through GitHub Pages on pushes to the default branch. Before enabling the workflow, configure Pages to use GitHub Actions, set actionrail.ai as the custom domain, and add the required DNS records. The deployment workflow connects the production form directly to the versioned ActionRail Hub waitlist endpoint. Local builds leave the endpoint unset by default and use the email fallback described above.

Structure

docs/
  docs/                 # MDX documentation content
  src/css/              # shared ActionRail/Docusaurus theme
  src/pages/            # custom landing page
  static/               # brand and social assets
  docusaurus.config.js  # site, search, navigation, and theme config
  sidebars.js           # documentation information architecture

Read the public documentation contribution guide before adding concepts or terminology.