Skip to content

docs(ui): point maintainer CTAs and GitHub App docs at self-hosting as the default path#2648

Merged
JSONbored merged 4 commits into
mainfrom
docs/self-host-primary-cta
Jul 3, 2026
Merged

docs(ui): point maintainer CTAs and GitHub App docs at self-hosting as the default path#2648
JSONbored merged 4 commits into
mainfrom
docs/self-host-primary-cta

Conversation

@JSONbored

@JSONbored JSONbored commented Jul 2, 2026

Copy link
Copy Markdown
Owner

Summary

  • Self-hosting is now the only way to get real, live PR reviews — the shared gittensory GitHub App + brokered relay is private/managed-beta only (docs(orb): separate telemetry from token brokerage #1939). Docs and CTAs across the site still presented installing the shared App as the primary/first onboarding step, which doesn't work for the general public.
  • Homepage hero + closing CTAs, /maintainers primary + closing CTAs now point at self-hosting setup instead of the shared App install URL.
  • docs/github-app.tsx now leads with self-hosting as the recommended path and reframes the shared App as private/managed-beta only; the rest of the page (settings, gate modes, config-as-code) is unchanged since it applies identically to either App.
  • docs/maintainer-workflow.tsx, docs/maintainer-install-trust.tsx, docs/beta-onboarding.tsx, docs/miner-workflow.tsx, docs/index.tsx: CTAs and "next step" links now point to self-hosting first.
  • docs-nav.tsx: removed the "Hosted app" subgroup label (implied hosted was the default); the same three pages now live in a "GitHub App & managed beta" subgroup listed after the self-hosting subgroups instead of before them.
  • Two gate-review rounds caught a real permission mismatch: the shared-App install checklist (Pull requests: read, optional Checks: write) was being routed to as if it also covered self-hosted installs, which actually need Pull requests: write and mandatory Checks: write (per docs/self-hosting-github-app.tsx). Both docs/github-app.tsx and docs/maintainer-install-trust.tsx now explicitly split the two paths and point self-hosted installs at the authoritative checklist.

No linked issue

This is a maintainer-lane docs/CTA correction discovered directly (not filed as its own issue) while investigating and fixing the homepage stats-counter bug this session — it implements the product-narrative shift already described in open issue #1939 ("shared App is private/managed-beta only, direct App install is the default").

No dedicated tests

Docs-only content/routing changes in apps/gittensory-ui (not src/**, not measured by Codecov). Verified manually in a running dev server (see below) rather than adding tests, consistent with how other docs-only PRs in this repo are validated.

Test plan

  • npm run ui:typecheck, npm run ui:lint, npm run ui:test, npm run ui:build — all clean
  • npm run test:ci (full local gate, unsharded) — green
  • npm audit --audit-level=moderate — 0 vulnerabilities
  • Manually verified in a running dev server: homepage hero CTA → /docs/maintainer-self-hosting, /maintainers CTAs → self-hosting, docs sidebar nav shows self-hosting subgroups first with the renamed "GitHub App & managed beta" subgroup last, /docs/github-app and /docs/maintainer-install-trust both correctly split self-hosted vs. shared-App permission guidance

…s the default path

Self-hosting is now the only way to get real, live PR reviews -- the shared
"gittensory" GitHub App + brokered relay is private/managed-beta only (#1939).
Docs and CTAs across the site still presented installing the shared App as the
primary/first onboarding step, which doesn't work for the general public.

- Homepage hero and closing CTAs, /maintainers primary + closing CTAs now point
  at self-hosting setup instead of the shared App install URL.
- docs/github-app.tsx now leads with self-hosting as the recommended path and
  reframes the shared App as private/managed-beta only; the rest of the page
  (settings, gate modes, config-as-code) is unchanged since it applies
  identically to either App.
- docs/maintainer-workflow.tsx, docs/maintainer-install-trust.tsx,
  docs/beta-onboarding.tsx, docs/miner-workflow.tsx, docs/index.tsx: CTAs and
  "next step" links now point to self-hosting first.
- docs-nav.tsx: removed the "Hosted app" subgroup label (implied hosted was the
  default); the same three pages now live in a "GitHub App & managed beta"
  subgroup listed after the self-hosting subgroups instead of before them.
@dosubot dosubot Bot added the size:L label Jul 2, 2026
@loopover-orb

loopover-orb Bot commented Jul 2, 2026

Copy link
Copy Markdown

Warning

🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨

⏸️ Gittensory review result - manual review recommended

Review updated: 2026-07-03 00:40:46 UTC

9 files · 1 AI reviewer · 1 blocker · readiness 100/100 · CI green · blocked

⏸️ Suggested Action - Manual Review

  • Maintainer test expectations unmet — Add or update tests, or attach passing validation output that satisfies the maintainer's test expectations.

Review summary
The diff coherently retargets maintainer CTAs and docs navigation from the shared App install flow to self-hosting, and the changed copy now distinguishes self-hosted permissions from the private managed-beta checklist. The visible route/link changes are internally consistent and the referenced self-hosted GitHub App page contains the authoritative permission list the new callouts point to. I do not see a reachable code, routing, or docs-contract break in the provided changed files.

Nits — 5 non-blocking
  • apps/gittensory-ui/src/routes/docs.beta-onboarding.tsx:114 says `/docs/maintainer-self-hosting` covers the direct App install checklist, but the authoritative checklist is `/docs/self-hosting-github-app`; tighten that sentence so readers land directly on the permission page.
  • apps/gittensory-ui/src/routes/docs.maintainer-install-trust.tsx:70 notes only two self-hosted permission differences; consider saying it is a partial warning and linking inline to the exact checklist so readers do not treat it as complete.
  • apps/gittensory-ui/src/routes/docs.beta-onboarding.tsx:114 should link the words `direct App's install checklist` to `/docs/self-hosting-github-app` after the self-hosting overview link.
  • apps/gittensory-ui/src/routes/docs.maintainer-install-trust.tsx:70 could mirror docs.github-app.tsx:80 by ending the callout with a direct `GitHub App and Orb` link to the full permission and event list.
  • Code changes lack test evidence — Add focused regression tests or explain why existing coverage is sufficient.

Concerns raised — review before merging

  • Maintainer test expectations unmet — Add or update tests, or attach passing validation output that satisfies the maintainer's test expectations.
Signal Result Evidence
Code review ❌ 1 blocker 1 reviewer
Linked issue ✅ No-issue rationale PR body explains why no issue is linked.
Related work ✅ No active overlap found No same-issue or scoped active PR overlap found.
Change scope ✅ 20/20 Low review scope from cached public metadata (size label size:L; no linked issue context).
Validation posture ✅ 25/25 PR body includes validation/test evidence.
Contributor workload ✅ 10/10 Author activity: 61 registered-repo PR(s), 52 merged, 506 issue(s).
Contributor context ✅ Confirmed Gittensor contributor JSONbored; Gittensor profile; 61 PR(s), 506 issue(s).
Gate result ❌ Blocking Repo-configured hard blocker found.
Review context
  • Author: JSONbored
  • Role context: owner (maintainer lane)
  • Public audience mode: oss maintainer
  • Lane context: Repository registration is not available in the local Gittensory cache.
  • Public profile languages: not available
  • Official Gittensor activity: 61 PR(s), 506 issue(s).
  • PR-specific overlap: none found.
Contributor next steps
  • Treat this as maintainer-lane context rather than normal contributor-lane activity.
  • No action.
  • Link the issue being solved, or explicitly explain why this is a no-issue PR.
Signal definitions
  • Related work = same linked issue, overlapping active PRs, or title/path similarity.
  • Change scope = cached public metadata such as size labels, draft state, and review-burden hints.
  • Validation posture = whether the PR provides enough public validation/test evidence for maintainer review.
  • Contributor workload = public contributor activity and cleanup pressure, not a repo-wide quality failure.
  • Contributor context = public GitHub/Gittensor identity context; non-Gittensor status is not a blocker.

🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed


💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →.

Checked by Gittensory, a quiet PR intelligence layer for OSS maintainers.

  • Re-run Gittensory review

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 2, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
gittensory-ui 4a1cf66 Commit Preview URL

Branch Preview URL
Jul 03 2026, 12:30 AM

…nits

The new "applies identically whichever App you install" claim on docs/github-app.tsx
was wrong for the install/permission steps: a self-hosted direct App needs Pull
requests: write and mandatory Checks: write (per docs/self-hosting-github-app.tsx),
while this page's install checklist -- written for the shared managed-beta App --
only asks for Pull requests: read and optional Checks: write. A self-hosted
maintainer following the new self-host-first CTA could create an under-scoped App.

- Narrow the "applies identically" claim to the review-behavior sections only.
- Point self-hosted installs at the authoritative self-hosting-github-app checklist
  instead of the shared-App one, with a callout on the exact permission delta.
- Apply the review's remaining nits: rename the page to "GitHub App configuration"
  to match the nav/CTA copy, and fix maintainer-install-trust.tsx's description to
  lead with self-hosting instead of undercutting it.
…stall-trust.tsx

Same class of bug as the previous gate-review fix on docs/github-app.tsx: this
page's paragraph presented self-hosting and the shared managed-beta App as equal
alternatives right above a permission checklist that's actually scoped to the
shared App only (Pull requests: read, optional Checks: write) -- a self-hosted
maintainer following the recommended path here would under-scope their App.

Split the two paths explicitly and point self-hosted installs at the
authoritative self-hosting-github-app checklist, with a callout on the exact
permission delta, mirroring the docs/github-app.tsx fix.
…tion)

- docs.beta-onboarding.tsx's maintainer step 1 sent self-hosted readers to
  docs/github-app's checklist (shared-App-only) as if it were the self-host
  install steps; now points to self-hosting setup for install and reframes
  docs/github-app as review-behavior configuration.
- docs.maintainer-install-trust.tsx's meta description still framed generic
  "Install Gittensory as a maintainer" without the self-host-first positioning
  the page body now has.
@JSONbored
JSONbored merged commit ea5da2a into main Jul 3, 2026
12 checks passed
@JSONbored
JSONbored deleted the docs/self-host-primary-cta branch July 3, 2026 00:44
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.

Development

Successfully merging this pull request may close these issues.

1 participant