Skip to content

Mark repository as superseded by docs-showcase - #452

Merged
pulkit004 merged 1 commit into
mainfrom
chore/mark-repo-superseded
Jul 28, 2026
Merged

Mark repository as superseded by docs-showcase#452
pulkit004 merged 1 commit into
mainfrom
chore/mark-repo-superseded

Conversation

@pulkit004

Copy link
Copy Markdown
Contributor

Why

docs.setu.co has been served by brokentusk/facade/docs-showcase since the cutover on 28 July 2026. This repository and the brokentusk/facade/docs-mdx renderer 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 edit content/ 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

File Change
README.md Deprecation banner above everything else. Existing content kept, marked historical.
DEPRECATED.md New. Full explanation: what this repo was, what replaced it, cutover date, parity baselines, what still lives here, and a table of what to do for each common task.
.github/PULL_REQUEST_TEMPLATE.md New — none existed. Tells anyone opening a PR that the repo is frozen and where to go.
.github/ISSUE_TEMPLATE/config.yml New — no ISSUE_TEMPLATE/ existed. blank_issues_enabled: false plus contact links to docs-showcase issues, docs.setu.co, and DEPRECATED.md.
CLAUDE.md Notice at top. Worth doing explicitly: this file instructs coding agents to edit content/ and run the ingestion pipelines, which would now be wrong.
content/README.md Notice at top. It is the content-authoring guide and its frontmatter/component conventions are the pre-Fumadocs ones.

There 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.co still reads this repository's main branch at runtime. brokentusk/facade/api-playground fetches, per request:

  • raw.githubusercontent.com/SetuHQ/docs/main/api-playground/json/…
  • raw.githubusercontent.com/SetuHQ/docs/main/api-playground/products.json
  • raw.githubusercontent.com/SetuHQ/docs/main/api-references/{spec}.json|yaml

Both the site and those raw URLs are live (verified today). So api-playground/README.md was 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

  • main tip is e226a98, staging tip is 16dcd01 — the parity baselines in DEPRECATED.md.
  • docs.setu.co is served by docs-showcase: the live homepage <title> traces to src/lib/seo.ts and src/app/(docs)/page.tsx on docs-showcase main, and does not exist anywhere in docs-mdx.
  • docs-staging.setu.co and docs-v2-staging.setu.co return byte-identical responses (same origin); the old parallel-domain docs-v2.setu.co now 404s.
  • Content parity: comparing page sets after normalising the section.mdxsection/index.mdx + meta.json shape, every upstream page on main has a counterpart in docs-showcase main, and every page on staging has one in development. The only residue is the 7 files UPSTREAM_SYNC.md marks as deliberate main deletions, the Signal IQ apis/* pages that became Scalar spec routes, and sample-category/sample-product/sample-page.
  • docs-ingestion/ and docs-embeddings/ correspond to rag/ingestion/ and rag/embeddings/ in docs-showcase.
  • docs-mdx's last commit was 2026-03-31 — dormant.

Things I was unsure about — please check

  1. docs/UPSTREAM_SYNC.md in docs-showcase only exists on the unmerged sync/docs-main branch, not on main or development. DEPRECATED.md points at it as the authoritative parity record, so that link is a promise that only holds once the branch merges.
  2. That file's staging row is still blank (ported up to: —), and it says main here maps to docs-v2.setu.co, which now 404s. I verified the staging content really is ported to development and did not repeat either stale claim, but the file should be refreshed post-cutover.
  3. Staging content parity is real but lands on development, not main — Signal IQ and UPI Issuance are not live on docs.setu.co. DEPRECATED.md says 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)

  • Archiving. Recommended once the API playground no longer reads this branch — archiving makes the repo read-only, which would freeze those runtime-fetched files but also block any playground mock update. Raw URLs keep working on archived public repos, so archiving does not break the playground's reads, only future edits. Owner's call; not touched.
  • .github/workflows/docs-ingestion-ci.yml — untouched as agreed. It still runs on every PR to main/staging.
  • .github/workflows/checklist.yml — worth a look. It auto-comments a "Checklist to merge a PR" on every PR opened against main/staging, walking people through adding MDX pages, updating menuItems.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.
  • Repo description still reads "Setu Documentation : Content + API References"; prefixing [SUPERSEDED] would show the status in search results and org listings, where READMEs are not visible.
  • Open branches. Many unmerged branches exist; anything still wanted has to be re-applied to docs-showcase by hand.
  • 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.

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>
@github-actions

Copy link
Copy Markdown

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) page

Checklist

  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • If a redirect is needed to the existing page, add a key, value pair in redirects.json

Edit an existing API reference page

Checklist


Add a new content (MDX) page

Checklist

  • Create a .mdx file with the path as its name in the content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • Created a folder with the same name, if any children were to be added to the page
  • Once all changes are done, update the menu items by using the Menu Items option
  • Add a key, and value pair in redirects.json if you wish to have a redirect to the new page

Add a new API reference page

Checklist

  • Create a .json file with the product path as its name
  • Create an api-reference.mdx file in the respective product folder inside content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Add API reference in JSON format (OpenAPI or Swagger) into created .json file.
  • Used the Content preview portal to view changes
  • Once all changes are done, update the menu items by using the Menu Items option

@pulkit004
pulkit004 merged commit eac1753 into main Jul 28, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants