Skip to content

improvement(landing): serve the homepage as Markdown when clients ask for text/markdown - #9154

Merged
waleedlatif1 merged 2 commits into
stagingfrom
improvement/homepage-markdown-negotiation
Oct 17, 2026
Merged

waleedlatif1 merged 2 commits into
stagingfrom
improvement/homepage-markdown-negotiation

Conversation

@waleedlatif1

Copy link
Copy Markdown
Collaborator

Summary

  • / now answers Accept: text/markdown with a Markdown version of the homepage (new /index.md route, beforeFiles rewrite); q=0 and browser requests keep the HTML
  • The Accept patterns are shared with the existing Markdown 404 fallback rewrite, so both rules negotiate the same way
  • Vary: Accept on / (both variants); the Markdown is no-store like the HTML there, and /index.md carries Link: rel="canonical" to the homepage
  • Homepage HTML advertises the Markdown via <link rel="alternate" type="text/markdown">
  • Hero heading, hero summary, and feature list moved to shared constants used by the hero, the JSON-LD, and /index.md; Pricing/Docs/GitHub/Sitemap link lines shared between /llms.txt and /index.md
  • /index.md includes a "Build with code" section with the exact SDK and CLI install commands (agents were guessing wrong npm package names)
  • Docs: redirect the retired /sdks, /sdks/typescript, /sdks/python pages to their api-reference successors (they 404 today), and name the SDK packages at the top of the API quickstart
  • check:file-names allows .md route folders named after their URL, alongside .txt/.xml/.json/.mdx

Type of Change

  • Improvement

Testing

  • New test-landing-seo-e2e.ts check (runs in CI against the production build): Markdown for text/markdown, HTML for q=0 and browser Accept, Vary: Accept on both, no-store on the Markdown, the alternate link, and /index.md matching the negotiated body with its canonical Link
  • scripts/openapi/docs-redirects.test.ts, lint, check:file-names, check:source-conventions, check:comment-hygiene, check:unused-exports, check:utils, check:client-boundary; full audits, type-check, and test suites in CI

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing (new tests pass the test-audit authoring gate)
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel

vercel Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 17, 2026 12:01am UTC

Request Review

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All reported issues were addressed across 12 files

Reply with feedback, questions, or to request a fix.

Turn on auto-fix | Re-trigger cubic

Comment thread apps/sim/next.config.ts
Comment thread apps/sim/app/index.md/route.ts Outdated
@greptile-apps

greptile-apps Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Medium impact] The changes since the previous review appear safe to merge.

Summary

Adds a Markdown version of the homepage for clients that request text/markdown.

  • The homepage serves Markdown to clients that ask for it.
  • SDK docs name install commands and old SDK links reach current pages.

Diagram

%%{init: {'theme': 'neutral'}}%%
flowchart TD
  Request["Request /"] --> Accept{"Accepts Markdown?"}
  Accept -->|"Yes, without q=0"| Markdown["Rewrite to /index.md"]
  Accept -->|No| HTML["Serve homepage HTML"]
  Markdown --> Response["Markdown response with no-store"]
  HTML --> Alternate["HTML advertises /index.md"]
Loading

Reviews (2) · Last reviewed commit: "improvement(landing): describe the Markd..." · Reviewed by Greptile

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@greptile

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@cubic-dev-ai review this PR

@cubic-dev-ai

cubic-dev-ai Bot commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

@cubic-dev-ai review this PR

@waleedlatif1 I have started the AI code review. It will take a few minutes to complete.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 12 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Turn on auto-fix | Re-trigger cubic

@waleedlatif1
waleedlatif1 merged commit d44cee4 into staging Oct 17, 2026
54 checks passed
@waleedlatif1
waleedlatif1 deleted the improvement/homepage-markdown-negotiation branch October 17, 2026 00:14

This branch was previously deployed

1 inactive deployment
Preview — 75bb4db5 Deployed Oct 17, 2026 by vercel[bot]
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.

1 participant