Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

AskUI Docs

The user documentation of AskUI Desktop, the AskUI CLI and AgentOS, published at docs.askui.com.

The site is a Fumadocs app on Next.js, exported as static HTML and served by GitHub Pages. The pages are MDX files in content/docs/.

Versions

The site shows the docs of every AskUI Desktop minor release behind a version dropdown in the sidebar:

URL Content
/docs/… the newest released version
/docs/v0.10/…, /docs/v0.9/…, … each older minor release

Each version describes exactly what that app release shipped. A minor release whose docs did not change shares a version with the next one (v0.9 – v0.10).

The pages of every version, the newest included, come from release tags. Everything around them (layout, search, tracking, consent banner) comes from main. So a docs page goes live with its app release, while a change to the site itself goes live as soon as it is merged.

Write the docs

  1. Branch from main and edit content/docs/. main always holds the docs of the next release.

  2. Run the site locally and check your pages:

    pnpm install
    pnpm dev            # http://localhost:3000/docs-rewrite/docs
  3. Before you open the PR, run both checks. types:check misses MDX parse errors that only the build finds:

    pnpm types:check
    pnpm build
  4. Merge the docs PR when its app PR is merged. The page goes live with the next release tag, not with the merge.

Release the docs

When an AskUI Desktop version is released, tag the same version here and push the tag. That deploys the site with the new version as the newest one:

git fetch origin
git tag -a v0.11.0 -m "Docs for AskUI Desktop v0.11.0" origin/main
git push origin v0.11.0
  • Release candidates (v0.11.0-rc1) get no tag and no docs version.
  • .github/workflows/deploy.yml runs on every release tag, on every merge to main (site changes, released pages unchanged) and by hand (Actions → Deploy to GitHub Pages → Run workflow).

Fix an older version

Older versions live on branches: release/v0.9, release/v0.10, …

  1. Commit the fix on the version's branch, e.g. release/v0.9.
  2. Tag it with the next patch number and push the tag: git tag -a v0.9.1 -m "…" release/v0.9, then git push origin v0.9.1.
  3. Run the deploy by hand: Actions → Deploy to GitHub Pages → Run workflow. The old branch does not carry the current workflow, so the tag alone starts nothing.

A fix to the newest version also goes on its release branch, not on main: main already holds the pages of the next release.

Preview the versioned site

# exactly what the deploy publishes: released pages, site from your checkout
NEXT_PUBLIC_BASE_PATH=ROOT node scripts/build-versioned.mjs --release
# or: the pages of your checkout as the newest version, plus the released ones
NEXT_PUBLIC_BASE_PATH=ROOT node scripts/build-versioned.mjs
pnpm start                     # http://localhost:3000/docs

pnpm dev and pnpm build build main alone, without the older versions.

Screenshots

Screenshots of AskUI Desktop are captured by an AskUI agent, not by hand. See screenshots-capture/README.md.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages