feat: add automatic markdown alternate links for docs pages#168
Merged
feat: add automatic markdown alternate links for docs pages#168
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.
@farming-labs/astro
@farming-labs/astro-theme
@farming-labs/docs
@farming-labs/theme
@farming-labs/next
@farming-labs/nuxt
@farming-labs/nuxt-theme
@farming-labs/svelte
@farming-labs/svelte-theme
@farming-labs/tanstack-start
commit: |
Contributor
There was a problem hiding this comment.
1 issue found across 19 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="packages/fumadocs/src/docs-layout.tsx">
<violation number="1" location="packages/fumadocs/src/docs-layout.tsx:627">
P2: Preserve the page locale when generating the markdown alternate URL; otherwise i18n pages will point crawlers to the wrong .md route.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
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 by cubic
Adds automatic text/markdown alternate links for docs pages across frameworks to improve discoverability and agent tooling, without changing page URLs or content. Alternates now preserve the active locale when present.
New Features
toDocsMarkdownUrlin@farming-labs/docsto build.mdURLs (preserves query/hash; appendslangwhen missing).<link rel="alternate" type="text/markdown">for docs pages when notstaticExport, preserving the current locale.@farming-labs/next/mdx-plugins/remark-markdown-alternateto inject markdown alternates via frontmatter; enabled bywithDocs, skipped if customalternatesexist.@farming-labs/themecreatePageMetadatanow setsalternates.types["text/markdown"]when a pageurlis provided and notstaticExport, preserving locale.headusingloaderData.urlandloaderData.localewhen notstaticExport.astro,nuxt,svelte,tanstack-start) now includeurlin load results.Migration
urlin the returned page data.staticExport: truein docs config, or pass{ enabled: false }to the Next remark plugin.Written for commit 714de85. Summary will update on new commits.