Repository navigation
[Trace] Meta length: shorten over-long docs meta descriptions - #172
Merged
Merged
Conversation
Playbook task: meta-length-checker (Google truncates descriptions over ~160 chars). Rewrites 26 frontmatter descriptions to <= 155 chars, keeping the main keyword first. Frontmatter description lines only. docs/SDKs/* and docs/API/* are left to their own Trace PRs. Three embedded-signing pages that exist only on feature/turbosign-embedded-identity are not included here.
1 of 3 tasks
This branch was successfully 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
1 participant
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.
Closes #166
Trace task:
meta-length-checker.mjs(Google truncates meta descriptions over ~160 characters).Replaces #167, which was built on top of
feature/turbosign-embedded-identityby mistake and carried those unrelated commits plus stray.claude/worktreessubmodule entries. This branch is cut fromdevelopand contains only frontmatterdescriptionedits.Changes
descriptionrewritten to <= 155 characters (longest is 145), main keyword first, no em-dashes. No other lines touched.docs/SDKs/*anddocs/API/*(their own Trace PRs fix meta in those files), and three embedded-signing pages that only exist onfeature/turbosign-embedded-identity(Embedded Signing.md,How to Configure One-Time Passcode.md,How to Enable Embedded Signing.md). Their descriptions are also over 160 characters; worth fixing on that branch before it merges.Test plan
descriptionlines only (26 files, 26 +/26 -)<meta name="description">Review vs SDK main
Two docs-accuracy issues found and fixed:
docs/TurboSign/Webhooks.md— the frontmatterdescriptionhad an unquoted bare:("events: sent"), which breaks YAML plain-scalar parsing and failsnpm run build/npm startfor this page (gray-matter, via Docusaurus'sparseMarkdownFile, throws on it). Fixed by wrapping the value in double quotes; text is unchanged.docs/Integrations/Teams.md— the rewrittendescriptiondropped the "Coming soon" qualifier the original had, describing the Microsoft Teams integration as available even though the page body itself is a "🚀 Coming Soon" placeholder. Restored an unmistakable not-yet-available qualifier up front.Also merged
developinto this branch to pick up #178 (cloudflare/pages-action→cloudflare/wrangler-action), since this branch's CI was still failing on the removed action.Deploy to Cloudflare Pagesis green on this branch as of this update: https://github.com/TurboDocx/Docs/actions/runs/35880030716