Public Presentation

Use this checklist when polishing the GitHub repository, npm package pages, docs links, release notes, or social preview for Super Admin.

Current Public State

As of 2026-07-25:

• The repository is public at lineo7387/super-admin.
• npm latest and next point to the smoke-verified release line:
  • create-super-admin@0.2.0
  • @super-admin-org/core@0.2.0
  • @super-admin-org/theme@0.1.5
  • @super-admin-org/theme-base@0.1.4
  • @super-admin-org/theme-crypto@0.1.4
  • @super-admin-org/theme-cyberpunk@0.1.4
  • @super-admin-org/theme-industrial@0.1.4
  • @super-admin-org/theme-newsprint@0.1.4
  • @super-admin-org/ui@0.1.6
• The GitHub Pages docs URL is https://lineo7387.github.io/super-admin/, and the complete mock-backed admin demo is https://lineo7387.github.io/super-admin/demo/.
• The public install path is available:

npm create super-admin@latest my-admin

The root package is private and is not published. The published package set is documented in Releasing.

GitHub About Settings

These settings are managed in GitHub, not in repository files.

Recommended values:

• Description: Frontend-first Vue admin template with reusable UI primitives, runtime themes, mock data, and replaceable API adapters.
• Website: https://lineo7387.github.io/super-admin/ after the GitHub Pages workflow has deployed successfully.
• Topics: vue, vite, typescript, admin-dashboard, admin-template, frontend, design-system, pinia, tanstack-query, vitepress.
• Social preview: use a screenshot or composed preview image of the admin shell, theme/profile switching, and example modules.

README Surface

The README should keep these above the fold:

• npm badge for create-super-admin.
• package or license badges that reflect current public state.
• npm create super-admin@latest my-admin.
• docs links for the hosted docs/demo, getting started, examples, API adapters, themes/layouts, and public presentation.
• a clear statement that backend, database, auth provider, AI provider, and generated schema are optional.

Use GitHub's dynamic latest release state for a GitHub Release badge instead of hard-coding a version. Use the docs/demo badge only after the GitHub Pages workflow is present.

Docs And Demo Links

Use these link positions:

• README: short "Preview And Docs" section near Quick Start.
• VitePress nav/sidebar: include this public presentation guide alongside releasing and open-source workflow.
• GitHub About website: https://lineo7387.github.io/super-admin/ after deployment succeeds.
• Release notes: link to README, Getting Started, Examples, API adapters, Themes and layouts, and Releasing.

The public demo is a static build of canonical apps/admin and requires no backend, database, auth provider, or AI provider. Login credentials are shown on the page. Maintainers can run the same app locally:

pnpm install
pnpm dev

Screenshot And Demo Assets

Delivered now:

• docs/public/super-admin-shell.png: captured by the real Chromium journey in scripts/admin-browser-smoke.mjs, showing the Cyberpunk dark profile, Top header, workspace tabs, and mock-backed Users module.
• /demo/: the complete static admin built into the GitHub Pages artifact by pnpm docs:build.

Optional follow-ups:

• docs/public/super-admin-themes.gif: short loop switching design profiles.
• docs/public/create-super-admin.gif: terminal flow from npm create super-admin@latest my-admin to npm run dev.

Regenerate the screenshot with ADMIN_SMOKE_SCREENSHOT_PATH=docs/public/super-admin-shell.png pnpm test:browser and inspect it before committing. Add a mobile or narrow-width screenshot only if the public page needs responsive proof. Do not commit blurred or purely atmospheric images; visitors should be able to inspect the actual product UI.

Release And Tag Copy

Suggested GitHub Release title for v0.2.0:

Super Admin v0.2.0 - readable extension contracts & built-in quality

Suggested summary:

Super Admin v0.2.0 makes extensibility source-readable and type-safe through immutable module manifests and typed layout/auth registries, while generated starters now ship a runnable quality baseline by default.

Suggested highlights:

• npm create super-admin@latest my-admin
• create-super-admin@0.2.0 on npm latest and next
• immutable feature manifest composition keeps navigation, routes, route meta, and permissions in one source-readable contract
• typed layout and auth recipe registries provide exact component contracts, duplicate detection, and neutral fallbacks
• generated standard starters include ESLint, Vitest, typecheck/build/check scripts, while --minimal is the explicit lightweight opt-out
• capability-aware AGENTS.md and ai-context/ document the real manifest/layout/auth extension seams without requiring an AI provider
• @super-admin-org/ui exposes Vue as a peer runtime instead of bundling a second copy into shared UI output
• packed starter validation covers default, multi-theme+i18n, ECharts, and minimal output, with registry smoke for default and all theme profiles
• the default starter remains frontend-first and mock-backed; backend, database, auth provider, AI provider, and maintainer release tooling remain optional

Suggested package matrix (all on npm latest and next):

• create-super-admin@0.2.0
• @super-admin-org/core@0.2.0
• @super-admin-org/theme@0.1.5
• @super-admin-org/theme-base@0.1.4
• @super-admin-org/theme-crypto@0.1.4
• @super-admin-org/theme-cyberpunk@0.1.4
• @super-admin-org/theme-industrial@0.1.4
• @super-admin-org/theme-newsprint@0.1.4
• @super-admin-org/ui@0.1.6

Create tags/releases only after confirming the release commit, npm dist-tags, and generated starter smoke result.

Maintainer Tooling Boundary

The source repository may include .trellis/, .agents/, .agent/, .claude/, .codex/, .mcp.json, skills-lock.json, and CodeGraph-related files. These are maintainer workflow aids.

Conservative policy:

• Do not remove or migrate them during public-presentation polish.
• Do not copy them into generated starters.
• Do not describe them as required setup for ordinary users.
• Explain them as optional maintainer/contributor aids when they appear in public docs.

Create a separate migration task only if the team decides the public tree should split maintainer workflow tooling into another repository or package.