Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 2.36 KB

File metadata and controls

38 lines (23 loc) · 2.36 KB

QueryFlux documentation site

This directory is a Docusaurus site that mirrors the root README.md and the docs/ Markdown in docs/ here. Canonical sources stay in the repository root (README.md, development.md, contribute.md, docs/); edit those and refresh the copies under website/docs/ when they drift, or automate sync in CI if you prefer.

Commands

npm install   # if node_modules is missing
npm start     # dev server (default http://localhost:3000)
npm run build # static output in build/
npm run serve # preview production build (search works here)

Search

Local search uses @cmfcmf/docusaurus-search-local (Docusaurus: local search): the index is built at compile time and shipped with the site—no Algolia or other hosted service.

The search bar appears in the navbar after a production build. It does not work with npm start (dev mode); use npm run build then npm run serve to try it locally. Versioned docs are supported (results follow the doc version you are viewing).

SEO

Global metadata, JSON-LD, and static/robots.txt follow Docusaurus SEO. If you change url, baseUrl, or hosting domain, update static/robots.txt Sitemap: to match (preset-classic already emits sitemap.xml).

Versioning

Docs follow Docusaurus versioning: docs/ is the Next draft (/docs/next/...). Published snapshots live under versioned_docs/ and versions.json.

When a release is ready to freeze:

npm run docs:version 0.2.0   # example; use your semver

Then edit sidebars.ts only for Next; for an older release, edit versioned_sidebars/version-X-sidebars.json and files under versioned_docs/version-X/. Keep sidebars.ts and version-0.1.0-sidebars.json in sync (same categories: Guides, Reference, Architecture, Frontends, Extending, Project).

Deployment URL

docusaurus.config.ts sets url and baseUrl for publication (e.g. GitHub Pages project sites often use baseUrl: '/queryflux/'). Adjust those values to match your hosting layout.