Skip to content

docs(config): document the shared.gittensory.yml (_shared) layer on quick-reference surfaces#5306

Merged
gittensory-orb[bot] merged 1 commit into
mainfrom
docs/shared-gittensory-yml-layer
Jul 12, 2026
Merged

docs(config): document the shared.gittensory.yml (_shared) layer on quick-reference surfaces#5306
gittensory-orb[bot] merged 1 commit into
mainfrom
docs/shared-gittensory-yml-layer

Conversation

@JSONbored

Copy link
Copy Markdown
Owner

Summary

The private shared-base layer (#1959, lowest-priority cross-repo house policy for multi-repo operators) is real, shipped, and fully tested — but invisible on every "quick reference" surface: TEMPLATES.md's catalog and layer table, both example-file headers, and the live docs.self-hosting-configuration.tsx page all omitted it. They were written ~3 hours before #1959 landed and never revisited. config/examples/README.md already documents it correctly and completely — this PR adds it everywhere else and links to README for the full precedence explanation.

Scope

Doc-only, additive: config/examples/TEMPLATES.md, config/examples/gittensory.full.yml (header, before the sync marker), config/examples/gittensory.minimal.yml (header, before the sync marker), docs.self-hosting-configuration.tsx.

Validation

  • npm run typecheck — clean
  • npx vitest run test/unit/config-templates.test.ts test/unit/docs-selfhost-activation-paths.test.ts — 23/23 (confirms the header edits stayed before the byte-sync marker)
  • npm run docs:drift-check — clean
  • npm run ui:lint — clean (0 errors)

Closes #5273

…uick-reference surfaces

The private shared-base layer (#1959, lowest-priority cross-repo
house policy for multi-repo operators) is real and fully tested but
was invisible on every quick-reference surface -- TEMPLATES.md's
catalog and layer table, both example-file headers, and the live
self-hosting-configuration docs page all omitted it, despite
predating #1959 by only ~3 hours and never being revisited.
config/examples/README.md already documented it correctly; this adds
it everywhere else and links to README for the full precedence
explanation.

Refs #5273
@superagent-security

Copy link
Copy Markdown
Contributor

Superagent didn't find any vulnerabilities or security issues in this PR.

@cloudflare-workers-and-pages

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 afe7ee0 Commit Preview URL

Branch Preview URL
Jul 12 2026, 01:35 PM

@gittensory-orb gittensory-orb Bot added the gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier. label Jul 12, 2026
@gittensory-orb

gittensory-orb Bot commented Jul 12, 2026

Copy link
Copy Markdown

Tip

🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩

✅ Gittensory review result - approve/merge recommended

Review updated: 2026-07-12 13:40:12 UTC

4 files · 2 AI reviewers · no blockers · readiness 100/100 · CI green · clean

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This is a doc-only PR that adds the previously-shipped `_shared` cross-repo base layer (#1959) to the quick-reference surfaces that predated it: TEMPLATES.md's catalog/table, both example-file headers, and the live self-hosting docs page. The additions are consistent with the existing README's documentation of the same feature and closes #5273 as claimed. The diff is small, additive, and low-risk — no code paths are touched, only comments and a docs route's static content array.

Nits — 7 non-blocking
  • The href in docs.self-hosting-configuration.tsx:173 hardcodes a github.com URL, consistent with the existing pattern in the same file (other links to config/examples/*), so it's fine but worth confirming the link resolves to the correct branch/path if `main` is renamed later.
  • No test changes accompany the docs.self-hosting-configuration.tsx edit; since this is a static JSX content addition (title/description strings), this is expected and low-risk, but confirm existing docs-drift-check/test suite (per PR description) actually asserts on this specific new list item's presence.
  • Consider verifying the anchor `#shared-base-layer-multi-repo-operators-1959` in TEMPLATES.md actually matches the heading id generated in config/examples/README.md to avoid a dead in-repo anchor link.
  • nit: config/examples/TEMPLATES.md:29 lists the lowest-priority shared base after the higher-priority private per-repo layer, which makes the layer table less intuitive for readers trying to understand precedence.
  • nit: apps/gittensory-ui/src/routes/docs.self-hosting-configuration.tsx:172 adds another hardcoded GitHub URL; that matches nearby links, but it keeps the docs page coupled to the current repository URL instead of a shared route/link helper if one exists.
  • PR author also opened the linked issue — Link an issue that was opened by a different contributor, or provide a rationale for why this self-authored issue represents genuine discovery work.
  • Code changes lack test evidence — Add focused regression tests or explain why existing coverage is sufficient.
Signal Result Evidence
Code review ✅ No blockers 2 reviewers, synthesized
Linked issue ✅ Linked #5273
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 (1 linked issue).
Validation posture ✅ 25/25 PR body includes validation/test evidence.
Contributor workload ✅ 10/10 Author activity: 44 registered-repo PR(s), 36 merged, 476 issue(s).
Contributor context ✅ Confirmed Gittensor contributor JSONbored; Gittensor profile; 44 PR(s), 476 issue(s).
Gate result ✅ Passing No configured blocker found.
Improvement ⚠️ ℹ️ None detected risk: low · value: none — No structural-improvement signals were detected for this PR. LLM value judgment: minor — The change closes a real documentation gap by surfacing an already-shipped, already-tested feature on public-facing quick-reference docs, which is useful but low-complexity and purely additive.
Linked issue satisfaction

Addressed
The diff adds the shared.gittensory.yml catalog row and layer-table row with README link in TEMPLATES.md, the header line in gittensory.full.yml, the third private destination note in gittensory.minimal.yml, and a fourth FeatureRow plus README link in docs.self-hosting-configuration.tsx — matching all four listed deliverables.

Review context
  • Author: JSONbored
  • Role context: owner (maintainer lane)
  • Public audience mode: oss maintainer
  • Lane context: Repository is configured for direct PR review.
  • Public profile languages: not available
  • Official Gittensor activity: 44 PR(s), 476 issue(s).
  • PR-specific overlap: none found.
Contributor next steps
  • Treat this as maintainer-lane context rather than normal contributor-lane activity.
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.
[BETA] Chat with Gittensory

Ask Gittensory a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.

  • @gittensory ask <question> answers contribution-quality Q&A with source citations and freshness.
  • @gittensory chat <question> answers in natural prose from cached decision-pack facts via local inference (maintainer/collaborator; read-only).
  • A plain-language @gittensory mention with a real question is routed to the closest matching read-only command automatically -- no exact syntax required.

Full command reference: https://gittensory.aethereal.dev/docs/gittensory-commands

Visual preview
Route Viewport Before (production) After (this PR's preview) Diff
/docs/self-hosting-configuration desktop before /docs/self-hosting-configuration after /docs/self-hosting-configuration
/docs/self-hosting-configuration mobile before /docs/self-hosting-configuration (mobile) after /docs/self-hosting-configuration (mobile)

Click any thumbnail to open the full-size screenshot. Before = production · After = this PR's preview deploy.

🟩 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

@gittensory-orb gittensory-orb Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Gittensory approves — the gate is satisfied and CI is green.

@gittensory-orb gittensory-orb Bot merged commit 75731df into main Jul 12, 2026
13 checks passed
@gittensory-orb gittensory-orb Bot deleted the docs/shared-gittensory-yml-layer branch July 12, 2026 13:40
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.

Document the shared.gittensory.yml (_shared) layer across templates and docs

1 participant