Skip to content

docs: stop docgen from linking parts of code spans - #367

Merged
robingenz merged 1 commit into
mainfrom
fix/docgen-code-span-links
Nov 5, 2026
Merged

robingenz merged 1 commit into
mainfrom
fix/docgen-code-span-links

Conversation

@robingenz

Copy link
Copy Markdown
Member

docgen linked every word in a description that matched a plugin type, even inside code spans. This broke the markdown, e.g. Language Identification in the translation README.

Changes

  • Extend the docgen patch: a code span is linked only if it names a plugin type as a whole (e.g. FaceMeshPoint). All other code spans stay plain and keep < and > as they are.
  • Regenerate the affected READMEs.

Note: turbo caches the docgen task, so run npx turbo run docgen --force once after pulling.

🤖 Generated with Claude Code

docgen linked every word in a description that matched a plugin type, also inside code spans. This broke the markdown and linked native names to the plugin's own types. A code span is now linked only if it names a plugin type as a whole. Code spans also keep < and > as they are.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@pkg-pr-new

pkg-pr-new Bot commented Nov 5, 2026

Copy link
Copy Markdown

Open in StackBlitz

@capacitor-mlkit/barcode-scanning

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/barcode-scanning@367

@capacitor-mlkit/digital-ink-recognition

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/digital-ink-recognition@367

@capacitor-mlkit/document-scanner

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/document-scanner@367

@capacitor-mlkit/entity-extraction

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/entity-extraction@367

@capacitor-mlkit/face-detection

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/face-detection@367

@capacitor-mlkit/face-mesh-detection

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/face-mesh-detection@367

@capacitor-mlkit/genai-image-description

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/genai-image-description@367

@capacitor-mlkit/genai-prompt

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/genai-prompt@367

@capacitor-mlkit/genai-proofreading

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/genai-proofreading@367

@capacitor-mlkit/genai-rewriting

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/genai-rewriting@367

@capacitor-mlkit/genai-speech-recognition

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/genai-speech-recognition@367

@capacitor-mlkit/genai-summarization

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/genai-summarization@367

@capacitor-mlkit/image-labeling

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/image-labeling@367

@capacitor-mlkit/language-identification

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/language-identification@367

@capacitor-mlkit/object-detection

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/object-detection@367

@capacitor-mlkit/pose-detection

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/pose-detection@367

@capacitor-mlkit/selfie-segmentation

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/selfie-segmentation@367

@capacitor-mlkit/smart-reply

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/smart-reply@367

@capacitor-mlkit/subject-segmentation

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/subject-segmentation@367

@capacitor-mlkit/text-recognition

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/text-recognition@367

@capacitor-mlkit/translation

npm i https://pkg.pr.new/capawesome-team/capacitor-mlkit/@capacitor-mlkit/translation@367

commit: 6d2c880

@robingenz
robingenz merged commit df12c57 into main Nov 5, 2026
6 checks passed
@robingenz
robingenz deleted the fix/docgen-code-span-links branch November 5, 2026 07:15
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