Skip to content

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

Description

@JSONbored

Context

config/examples/TEMPLATES.md's template catalog and layer table, the header comments in config/examples/gittensory.full.yml and gittensory.minimal.yml, and the live docs route apps/gittensory-ui/src/routes/docs.self-hosting-configuration.tsx all omit shared.gittensory.yml / the private _shared/.gittensory.yml layer entirely. This is a real, shipped, fully-tested feature (#1959, commit 702e0b21e) — it's just invisible on every "quick reference" surface because those four files were written ~3 hours before #1959 landed (commit 881bed2dc) and were never revisited. config/examples/README.md documents the feature correctly and completely; it's the only accurate source.

The live docs page is the most likely entry point for a self-host operator (more likely than browsing config/examples/ on GitHub), and it has zero link to README.md. A multi-repo operator has no product-surface path to discovering the shared-base convenience feature exists.

Requirements

  • Additive, doc-only — no code or schema changes.

Deliverables

  • TEMPLATES.md — add a catalog row for shared.gittensory.yml and a layer-table row for _shared/.gittensory.yml, plus a link to README's "Shared base layer" section.
  • gittensory.full.yml header — add shared.gittensory.yml — private cross-repo house policy, lowest-priority layer (#1959).
  • gittensory.minimal.yml header — mention the third private destination (${GITTENSORY_REPO_CONFIG_DIR}/_shared/.gittensory.yml).
  • docs.self-hosting-configuration.tsx — add a fourth FeatureRow for shared.gittensory.yml, a matching <li> link, and a link to config/examples/README.md (currently linked nowhere on this page).

Expected Outcome

A self-host operator managing multiple repos can discover the shared-base layer from any of the "quick reference" surfaces, not only README.md.

Links & Resources

  • Evidence: config/examples/TEMPLATES.md:9-14,21-27; config/examples/gittensory.full.yml:14-18, gittensory.minimal.yml:5-9; apps/gittensory-ui/src/routes/docs.self-hosting-configuration.tsx:108-126,144-167; config/examples/README.md:17-27,45-50,143-199

Part of #5270 (roadmap epic).

Metadata

Metadata

Assignees

Labels

maintainer-onlyOwner-only work — yields no Gittensor points.

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions