Mark repository as superseded by docs-showcase - #452
Merged
Conversation
Setu's developer docs moved to brokentusk/facade/docs-showcase (GitLab) on 28 July 2026, which holds content and rendering in one repository. This repo and the docs-mdx renderer are both superseded, but nothing here said so, so readers arriving from bookmarks and search results had no way to tell. Adds, without removing anything: - README.md: deprecation banner above the existing content, which is marked as historical rather than deleted. - DEPRECATED.md: what this repo was, what replaced it, the parity baselines, what still lives here, and what to do for each common task. - .github/PULL_REQUEST_TEMPLATE.md and .github/ISSUE_TEMPLATE/config.yml: redirect anyone opening a PR or issue (neither existed before). - CLAUDE.md and content/README.md: notices, since both give instructions that are now wrong. api-playground/ is deliberately excluded: api-playground.setu.co still fetches it from this branch at runtime, so those instructions still hold. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Checklist to merge a PR 🚀To merge this pull request, please take time to complete the checklist. What action did you perform?Review the corresponding checklist items for the action you performed and mark them done. Edit an existing content (MDX) pageChecklist
Edit an existing API reference pageChecklist
Add a new content (MDX) pageChecklist
Add a new API reference pageChecklist
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
docs.setu.cohas been served bybrokentusk/facade/docs-showcasesince the cutover on 28 July 2026. This repository and thebrokentusk/facade/docs-mdxrenderer are both superseded, but nothing in the repository says so. It is public, indexed, and heavily bookmarked, so people (and coding agents) still land here, read the README, and editcontent/expecting it to publish.This adds the standard "no longer maintained" signposting. It adds only — no file is deleted and no workflow is modified.
What this changes
README.mdDEPRECATED.md.github/PULL_REQUEST_TEMPLATE.md.github/ISSUE_TEMPLATE/config.ymlISSUE_TEMPLATE/existed.blank_issues_enabled: falseplus contact links to docs-showcase issues, docs.setu.co, andDEPRECATED.md.CLAUDE.mdcontent/and run the ingestion pipelines, which would now be wrong.content/README.mdThere is no
CONTRIBUTING.md,CODEOWNERS,SUPPORT.md, or pre-existing deprecation notice anywhere in the repo, so nothing conflicted.One thing that is deliberately not deprecated
api-playground.setu.costill reads this repository'smainbranch at runtime.brokentusk/facade/api-playgroundfetches, per request:raw.githubusercontent.com/SetuHQ/docs/main/api-playground/json/…raw.githubusercontent.com/SetuHQ/docs/main/api-playground/products.jsonraw.githubusercontent.com/SetuHQ/docs/main/api-references/{spec}.json|yamlBoth the site and those raw URLs are live (verified today). So
api-playground/README.mdwas left alone — its instructions are still correct — and the notices carve out this exception explicitly rather than telling people to stop editing here entirely. Worth confirming this is the intended steady state, or repointing the playground.Facts I verified rather than assumed
maintip ise226a98,stagingtip is16dcd01— the parity baselines inDEPRECATED.md.docs.setu.cois served by docs-showcase: the live homepage<title>traces tosrc/lib/seo.tsandsrc/app/(docs)/page.tsxon docs-showcasemain, and does not exist anywhere indocs-mdx.docs-staging.setu.coanddocs-v2-staging.setu.coreturn byte-identical responses (same origin); the old parallel-domaindocs-v2.setu.conow 404s.section.mdx→section/index.mdx+meta.jsonshape, every upstream page onmainhas a counterpart in docs-showcasemain, and every page onstaginghas one indevelopment. The only residue is the 7 filesUPSTREAM_SYNC.mdmarks as deliberatemaindeletions, the Signal IQapis/*pages that became Scalar spec routes, andsample-category/sample-product/sample-page.docs-ingestion/anddocs-embeddings/correspond torag/ingestion/andrag/embeddings/in docs-showcase.docs-mdx's last commit was 2026-03-31 — dormant.Things I was unsure about — please check
docs/UPSTREAM_SYNC.mdin docs-showcase only exists on the unmergedsync/docs-mainbranch, not onmainordevelopment.DEPRECATED.mdpoints at it as the authoritative parity record, so that link is a promise that only holds once the branch merges.stagingrow is still blank (ported up to: —), and it saysmainhere maps todocs-v2.setu.co, which now 404s. I verified the staging content really is ported todevelopmentand did not repeat either stale claim, but the file should be refreshed post-cutover.development, notmain— Signal IQ and UPI Issuance are not live on docs.setu.co.DEPRECATED.mdsays so; flagging in case that is not the intent now that cutover is done.Follow-ups that need a repo owner (not done here, deliberately)
.github/workflows/docs-ingestion-ci.yml— untouched as agreed. It still runs on every PR tomain/staging..github/workflows/checklist.yml— worth a look. It auto-comments a "Checklist to merge a PR" on every PR opened againstmain/staging, walking people through adding MDX pages, updatingmenuItems.json, and using the Docter preview extension. All of that is now wrong, and the bot's comment will appear directly below the new PR template that says the opposite. I did not modify it, since disabling a workflow felt like an owner decision adjacent to the ingestion-CI one.[SUPERSEDED]would show the status in search results and org listings, where READMEs are not visible.vscode-docter-preview(SetuHQ/vscode-docter-preview) is referenced from the README and the checklist bot and is presumably also superseded — out of scope here.