Skip to content

docs(ui): add role-based beta onboarding journeys - #205

Merged
JSONbored merged 6 commits into
JSONbored:mainfrom
claytonlin1110:docs/beta-onboarding-journeys
Jun 1, 2026
Merged

docs(ui): add role-based beta onboarding journeys#205
JSONbored merged 6 commits into
JSONbored:mainfrom
claytonlin1110:docs/beta-onboarding-journeys

Conversation

@claytonlin1110

@claytonlin1110 claytonlin1110 commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add /docs/beta-onboarding with role-first paths for miners (MCP install → login → doctor → agent plan → preflight → packet), maintainers (GitHub App → settings → settings-preview → @gittensory commands), repo owners (registration readiness + config guidance), and operators (usage/value dashboard + upstream drift).
  • State product positioning: Gittensory is an independent base-agent/control-plane layer for the Gittensor ecosystem, not an official Gittensor frontend; document public vs private output boundaries per issue requirements.
  • Wire the page from docs overview (including a new Operators card), sidebar nav, quickstart, sitemap, and command palette; add test/unit/docs-beta-onboarding.test.ts for journey coverage and positioning copy.

Closes #153

Scope

  • This PR is focused and does not mix unrelated backend, UI, MCP, docs, dependency, and deploy changes.
  • This follows CONTRIBUTING.md and does not reintroduce GitHub Pages, VitePress, site/, or CNAME.
  • I linked an issue, or this is small enough that the summary explains why an issue is not needed.

Validation

  • git diff --check
  • npm run actionlint
  • npm run typecheck
  • npm run test:coverage locally; global coverage stays at or above 97% for lines, statements, functions, and branches (aim for 98%+ branch coverage locally so CI variance does not fail near the threshold)
  • npm run test:workers
  • npm run build:mcp
  • npm run test:mcp-pack
  • npm run ui:openapi:check
  • npm run ui:lint
  • npm run ui:typecheck
  • npm run ui:build
  • npm audit --audit-level=moderate
  • New or changed behavior has unit/integration tests for new branches, fallback paths, and sanitizer boundaries

If any required check was skipped, explain why:

Safety

  • No secrets, wallet details, hotkeys, coldkeys, user PATs, private keys, raw trust scores, private rankings, or private maintainer evidence are exposed.
  • Public GitHub text stays sanitized, low-noise, and does not imply compensation guarantees or optimization tactics.
  • Auth, cookie, CORS, GitHub App, Cloudflare, or session changes include negative-path tests.
  • API/OpenAPI/MCP behavior is updated and tested where needed.
  • UI changes use live API data or real empty/error/loading states, not production mock/demo fallbacks.
  • Visible UI changes include screenshots or a short recording.
  • Public docs/changelogs are updated where needed; changelogs are only edited for release-prep PRs.

@superagent-security superagent-security Bot added the pr:flagged PR flagged for review by security analysis. label Jun 1, 2026
@superagent-security

superagent-security Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Superagent found 1 security concern(s).

P2: Unexplained binary zip artifact added in public downloads directory

Binary zip added without source, build context, or PR explanation.

Remove opaque binary and deliver via release pipeline with provenance; or document build source and checksum.

AI prompt
Check if this security scanner issue is valid. If so, understand the root cause and fix it. If appropriate, update or add tests. Keep the change focused and preserve intended behavior.

<file name="apps/gittensory-ui/public/downloads/gittensory-extension.zip">
<violation number="1" location="apps/gittensory-ui/public/downloads/gittensory-extension.zip">
<priority>P2</priority>
<title>Unexplained binary zip artifact added in public downloads directory</title>
<evidence>The PR adds a binary file `apps/gittensory-ui/public/downloads/gittensory-extension.zip` with no patch content, source code, build configuration, or provenance details, within a docs-only change set. The file is not mentioned in the PR description or validation checklist.</evidence>
<recommendation>Verify the zip's origin and contents. If it is a build artifact, remove it from git and serve it through an automated release pipeline with published checksums/SBOM. If legitimate, add build scripts and document provenance in the PR.</recommendation>
</violation>
</file>

@superagent-security superagent-security Bot removed the pr:flagged PR flagged for review by security analysis. label Jun 1, 2026

@JSONbored JSONbored left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@claytonlin1110 this is ready from my pass.

A few notes:

  • The new beta onboarding route is wired into docs nav, command palette, sitemap, and the generated route tree.
  • The tests cover the miner, maintainer, repo owner, and operator journeys at the right level for a docs route.
  • CI is green and the branch merges cleanly with current main.

No code changes requested.

@dosubot dosubot Bot added the lgtm label Jun 1, 2026
@JSONbored
JSONbored merged commit 1fab423 into JSONbored:main Jun 1, 2026
3 checks passed
@JSONbored JSONbored added the gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier. label Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(launch): add role-based beta onboarding journeys

2 participants