Before you use it
- Use when
- A message ends with a pile of links and screenshots whose purpose is unclear.
Keep this limit in mind
- Links can rot and permissions can fail; preserve required evidence according to the system's retention rules.
Current editorial reading
Pin the relevant evidence
For code on GitHub, link the reviewed commit and relevant lines instead of relying on a moving branch URL. On a file page, pressing Y changes the URL to the commit-specific version. For operational evidence, identify the relevant run or object and the observation time alongside the log or result. Those workflow details are an editorial extension of the same version-binding principle.
Keep identity separate from proof
For example: “The parser at this commit rejects an empty key; see these lines and the matching test result.” That does not establish which build is deployed. Check the connection between the evidence and the claim separately, and confirm the intended recipient can open it. Preserve required records through approved retention procedures; a precise link does not expand sharing permission or guarantee permanent access. Keep a separate current-state link when readers need the latest guidance; label the evidence snapshot as historical.
Take it with you
A reviewer should reach the exact evidence behind the claim and see its limits. For changing content, include the version or run identity, not just a clickable location.
Sources and evidence (1)
What we checked
GitHub file links that specify a commit identify the exact version in that commit; the Y shortcut creates such a permalink.
Official documentation inspected on 2026-10-05. The proposed run/log identity practice is an editorial application, not a documented GitHub runtime guarantee.
Getting permanent links to files · Press Y to permalink to a file in a specific commit
A normal file URL using a branch name can show different content after new commits change that branch.
Limits the original link-placement advice: a reachable branch link alone does not preserve what the author inspected. No deployed build or account permissions were tested.
Getting permanent links to files · File views show the latest version on a branch
Editorial sources (1)
Save and practise this idea
My learning
Read. Recall. Repeat.
Save this idea and return to it on any device.
Keep exploring
Connected ideas
You are readingPoint to the evidence version you actually checked
Original edition evidence and sources
These records belong to the original released edition. The current editorial reading has its own evidence above; neither set silently replaces the other.
CDC guidance recommends lists, chunks and descriptive headings to make information easier to scan and organize.
Very short messages may not need headings; structure should match complexity.
Description and Examples of Index Items · Core items 8 through 10
ONS guidance recommends writing around user needs, removing content that does not serve those needs, and using concise task-focused headings.
Regulated or audit-heavy work may require context that feels redundant to the immediate reader.
Writing and editing: Plain language · Put users' needs first; titles and headings; be concise
Original edition, downloads and provenance
The reading above is editorial version 1.0.0, bound to this exact source edition. The original data and saved downloads retain that edition and the separate editorial layer. They may contain earlier wording; use the current reading above when interpreting it.
Version 0.1.0
No review details are supplied for this edition.
Read the original edition and overlay as JSON · Release details
