Skip to content

docs site: gitConfig.repo is the pre-rename framework, so every GitHub link (and now codeRepository) rides a redirect #12354

Description

@os-zhuang

One-liner

apps/docs/lib/layout.shared.tsx declares gitConfig.repo = 'framework', but this repository is objectstack-ai/objectstack. Every GitHub URL the docs site emits therefore relies on GitHub's rename redirect.

Measured

$ gh api /repos/objectstack-ai/framework --jq '.full_name'
objectstack-ai/objectstack

The old name still resolves — GitHub keeps a permanent redirect after a rename — so nothing is visibly broken today. What is emitted:

  • the nav bar's GitHub link (baseOptions().githubUrl)
  • the homepage hero's GitHub button
  • every doc page's "Edit on GitHub" link, …/framework/blob/main/content/docs/<path>
  • as of docs site: no structured data (JSON-LD) anywhere #12240, SoftwareSourceCode.codeRepository in the homepage JSON-LD

Why it is worth a line of code

The first three are redirects a user never notices. The fourth is different: codeRepository is a machine-readable identity claim, and a consumer that resolves it gets a 301 to a different name than the one asserted. Redirects are also revocable — a future org that creates a new repo named framework silently repoints every one of these links.

Fix

One line: repo: 'objectstack' in apps/docs/lib/layout.shared.tsx. Worth a rendered check of one doc page's edit link afterwards, since that URL is assembled from user/repo/branch plus page.path.

Source

Found while implementing #12240 — the JSON-LD needed a codeRepository, and reusing the site's own constant meant checking what it points at.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions