Skip to content

docs: refresh local demo and analytics setup guides - #136

Open
johnnyhuy wants to merge 1 commit into
mainfrom
agent/issue-135-local-demo-guides
Open

johnnyhuy wants to merge 1 commit into
mainfrom
agent/issue-135-local-demo-guides

Conversation

@johnnyhuy

Copy link
Copy Markdown
Contributor

Replace the removed make workflow in the demo entry page and tracking guide with existing mise tasks. Explain guest access, local config preparation and database resets, plus the optional Plausible stack's ports, secrets, frontend settings and matching teardown task.

Part of #85.
Closes #135.

This is a documentation-only slice. The portal UI, configuration and runtime code are unchanged. The documents are the proof, using evidence method (d); screenshot capture is not applicable.

Verified locally on a3295c5

  • mise run install passed with peer dependency warnings.
  • mise run lint passed TypeScript checks and ESLint across all five workspaces.
  • mise run test -- --runInBand --verbose passed 45 tests in seven suites, with one existing skipped test and suite. There are no new behaviour tests for this documentation change.
  • mise run --dry-run install ::: dev ::: lint ::: test ::: build ::: up ::: down ::: plausible-up ::: plausible-down resolved all nine documented task names and their init dependency. This checked task definitions without starting services.
  • git diff --check passed. Prettier formatted both guides through a temporary local mise run proof-docs-format task, removed before the commit.

The local mise commands used the worktree-scoped MISE_TRUSTED_CONFIG_PATHS="$PWD" environment setting after reviewing the repo configuration. The initial attempt without it stopped at the untrusted-worktree check before installation.

mise run install
YN0000: Done with warnings in 1m 18s
Finished in 80.43s

mise run lint
Checked   2 files in packages/backend
Checked   3 files in plugins/permission-backend-module-default
Checked   1 files in packages/backstage-theme-github
Checked   8 files in plugins/plausible
Checked  51 files in packages/app

mise run test -- --runInBand --verbose
Test Suites: 1 skipped, 7 passed, 7 of 8 total
Tests:       1 skipped, 45 passed, 46 total
Snapshots:   0 total
Time:        12.39 s
Ran all test suites in 4 projects.

The Docker services and live analytics collection were not exercised locally. mise run build was not required for this documentation-only slice; the PR Build workflow still runs all four mise gates. Existing React/MUI/jsdom warnings remain. The parent demo-readiness epic stays open for deployment validation and the remaining product decisions.

Replace removed make targets with the existing mise workflow and explain guest access, configuration, and the optional analytics stack.

Co-authored-by: OpenAI Codex <noreply@openai.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: replace removed make targets in local demo guides

1 participant