WCPOS Documentation

The user documentation for WooCommerce POS — live at docs.wcpos.com.

About  —  Development  —  Writing docs  —  Deployment

💡 About

This repository is the public documentation site for WooCommerce POS (WCPOS) — a free, open-source Point of Sale for WooCommerce. It's written primarily for store owners and operators: getting started, installation, using the POS, managing products / orders / customers, coupons, receipts, hardware setup, payment gateways, settings and reports — plus a large troubleshooting section and a small developer reference (REST API internals, custom gateways).

The site is built with Docusaurus 3 and deployed on Vercel at docs.wcpos.com.

Notable features:

• Multilingual — 12 locales, kept in sync by automated translation tooling.
• Search — Algolia DocSearch.
• AI-friendly — generated /llms.txt and /llms-full.txt; append .md to any page URL for clean Markdown, and use the per-page "Copy page" / "Open in ChatGPT/Claude" buttons.

🗂 Structure

versioned_docs/
  version-1.x/        # ← the live documentation content (MDX), served at the site root
  version-0.4.x/      # legacy docs
versioned_sidebars/   # checked-in per-version sidebar config
i18n/                 # translations for all 12 locales
src/
  components/         # reusable MDX components (<Steps>, <FeatureCard>, <ProBadge>, …)
  theme/              # swizzled Docusaurus theme
  pages/              # custom standalone pages
static/               # images, svgs, robots.txt
scripts/              # translation automation, frontmatter validation, Algolia audit
docs/                 # internal notes only (ADRs) — NOT site content
docusaurus.config.js  # site configuration

Heads up: the live content is not in docs/ (that folder holds internal ADRs). Because the config sets lastVersion: '1.x' and includeCurrentVersion: false, all current content is authored under versioned_docs/version-1.x/ and served at the site root.

👩‍💻 Development

Prerequisites

• Node.js >=22.13 <23
• pnpm (pinned via packageManager)

pnpm install
pnpm start      # local dev server with hot reload

Common commands

Command	Description
pnpm start	Start the local dev server
pnpm build	Build the static site into build/ (all locales)
pnpm serve	Preview the production build locally
pnpm clear	Clear the Docusaurus cache
pnpm test	Run the script unit tests (Vitest)
pnpm translations:sync / :validate	Manage and validate translations

Lockfiles: local development uses pnpm (pnpm-lock.yaml, gitignored), while Vercel installs with npm (package-lock.json, committed). The two override lists are kept in sync — update both if you change dependencies.

✍️ Writing docs

1. Add or edit an .mdx file under versioned_docs/version-1.x/<category>/.
2. Include the required frontmatter — title, sidebar_label, sidebar_position, and optionally slug and description. Frontmatter is validated at build time.
3. Update versioned_sidebars/version-1.x-sidebars.json when adding or moving pages. The live 1.x docs are served with includeCurrentVersion: false, so new MDX files under versioned_docs/version-1.x/ are omitted from navigation until this checked-in sidebar JSON is updated or regenerated.
4. Reuse the MDX components in src/components/ (e.g. <Steps>, <LinkCard>, <ProBadge>) for consistent styling.

Translations are not edited by hand per page — source (English) content is authored here and the other locales in i18n/ are produced by the automated translation workflows.

🚀 Deployment

The site auto-deploys via Vercel's Git integration: pushes to main deploy to production, and pull requests get preview deployments. The build.yml workflow runs a full production build (all locales) as a blocking PR gate.

🔗 Links

• 📚 Live docs — docs.wcpos.com
• 🌐 Website — wcpos.com
• 🔌 WordPress plugin — wordpress.org/plugins/woocommerce-pos
• 📦 Client monorepo — github.com/wcpos/monorepo
• 💬 Discord — wcpos.com/discord

---

_{Want to help translate the docs? Open an issue with the i18n label or say hello on Discord.}