Repository navigation
improvement(landing): serve the homepage as Markdown when clients ask for text/markdown - #9154
Merged
Merged
Conversation
… for text/markdown
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 12 files
Reply with feedback, questions, or to request a fix.
Turn on auto-fix | Re-trigger cubic
Contributor
[Medium impact] The changes since the previous review appear safe to merge. SummaryAdds a Markdown version of the homepage for clients that request
|
Collaborator
Author
Collaborator
Author
|
@cubic-dev-ai review this PR |
Contributor
@waleedlatif1 I have started the AI code review. It will take a few minutes to complete. |
This branch was previously deployed
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.
Summary
/now answersAccept: text/markdownwith a Markdown version of the homepage (new/index.mdroute,beforeFilesrewrite);q=0and browser requests keep the HTMLVary: Accepton/(both variants); the Markdown isno-storelike the HTML there, and/index.mdcarriesLink: rel="canonical"to the homepage<link rel="alternate" type="text/markdown">/index.md; Pricing/Docs/GitHub/Sitemap link lines shared between/llms.txtand/index.md/index.mdincludes a "Build with code" section with the exact SDK and CLI install commands (agents were guessing wrong npm package names)/sdks,/sdks/typescript,/sdks/pythonpages to theirapi-referencesuccessors (they 404 today), and name the SDK packages at the top of the API quickstartcheck:file-namesallows.mdroute folders named after their URL, alongside.txt/.xml/.json/.mdxType of Change
Testing
test-landing-seo-e2e.tscheck (runs in CI against the production build): Markdown fortext/markdown, HTML forq=0and browser Accept,Vary: Accepton both,no-storeon the Markdown, the alternate link, and/index.mdmatching the negotiated body with its canonicalLinkscripts/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 CIChecklist
test-auditauthoring gate)