Description
Add an estimated reading time indicator to documentation and tutorial pages. Displays as "🕒 X min read".
Motivation
Helps users gauge time commitment before starting a page. When readers know upfront that a doc is "3 min" vs "15 min", they can:
- Decide if they have time to finish it now
- Plan their reading session better
- Feel less overwhelmed by long pages
Research suggests visible time estimates improve completion rates by setting clear expectations.
Implementation
- Create
_includes/read_time.html component
- Calculate based on ~200 words/min average reading speed
- Display only on
docs_sidebar and tutorial_sidebar pages (excludes landing/community pages)
Scope
- Applies to
/content/docs/** and /content/tutorials/**
- Also covers imported submodule docs (openfoam-adapter, aste, etc.)
- Minimum 1 min displayed for short pages
Description
Add an estimated reading time indicator to documentation and tutorial pages. Displays as "🕒 X min read".
Motivation
Helps users gauge time commitment before starting a page. When readers know upfront that a doc is "3 min" vs "15 min", they can:
Research suggests visible time estimates improve completion rates by setting clear expectations.
Implementation
_includes/read_time.htmlcomponentdocs_sidebarandtutorial_sidebarpages (excludes landing/community pages)Scope
/content/docs/**and/content/tutorials/**