Skip to content

[Trace] Meta length: shorten over-long docs meta descriptions #166

Description

@nicolasiscoding

Change type

Standard — low-risk, pre-approved

Risk / impact

Low

Security impact assessed?

No — no security impact

Details — description & full context

Shorten 29 documentation file meta descriptions to fix Google truncation. Descriptions > 160 characters are truncated in search results. Reduced all violations from 48 to 19 (remaining 19 in docs/SDKs/ and docs/API/ owned by other PRs).

Before: 48 description violations across all docs
After: 19 violations (all in SDKs/ and API/)

Files changed: 29 documentation pages across:

  • TurboSign (5 files)
  • Pipelines (5 files)
  • Integrations (12 files)
  • TurboDocx Templating (3 files)
  • TurboQuote (2 files)

Approach: Rewrote each description to <= 155 characters while keeping:

  • Main keyword (e.g., "webhooks", "pipeline", "integrate")
  • Action-oriented language (what reader will do)
  • No em-dashes (U+2014)
  • Valid YAML quoting

No content outside of frontmatter descriptions was changed.

Component / area

Documentation meta descriptions

No activity

Activity on this issue will appear here.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

changeSOC 2 change management recorddocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions