Skip to content

DX-062: Add reading time and reading progress #574

Description

@IbrahimIjai

Context

Concept pages here run long. Telling a reader up front that a page is a
four-minute read or a twenty-minute one lets them decide whether to read now or
bookmark — a small affordance that measurably reduces bounce on long pages.

Scope

  • Compute reading time at build time from word count, excluding code blocks from
    the prose rate and counting them at a slower separate rate.
  • Display it under the page title alongside the last-updated date.
  • A slim reading-progress indicator in the header, driven by scroll position.
  • Respect prefers-reduced-motion; the indicator must never animate jerkily or
    cause layout shift.
  • Hide both on pages under a minimum length, where they are noise.

Acceptance criteria

  • Reading time is computed at build time, not on the client.
  • The progress indicator causes no layout shift and no scroll jank.
  • Short pages show neither affordance.
  • The indicator is decorative and hidden from assistive technology.

Out of scope

  • Persisted per-user reading position.

Spec: docs/dx_1/001_docs_site.md · Depends on: DX-061

Activity

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

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardStellar WaveIssues in the Stellar wave programThird CampaignCampaign: Third CampaigndocumentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions