agentleFS
Sign inStart free
d-o-hubd-o-hub/github-template-ai-agents/.agents/skills/document-rendering-and-locators/SKILL.md

document-rendering-and-locators

Skill2 starsChanged 10 days agoMITView on GitHub

Implement resilient document rendering and annotation anchoring. Use this skill when working with reader-core rendering, TOC generation, locator systems, or highlight anchoring changes — even if they just say "fix the document rendering" or "the highlights aren't sticking". Generic pattern applicable to EPUB, PDF, or any document format. Not for reader-ui-ux.

The file

Create a free account to mount
Files
SKILL.md

Document Rendering and Locators

Purpose: implement resilient document rendering, locator extraction, and annotation anchoring.

When to Use

  • Integrating document rendering library or reader-core changes.
  • Working on TOC, locator, or highlight/comment anchoring logic.
  • Debugging annotation drift or document loading regressions.

Workflow

  1. Define data model -- confirm multi-signal locator requirements (position + text + chapter + DOM fallback).
  2. Design anchors -- map DOM selections --> { position, selectedText, chapterRef, elementIndex, charOffset }.
  3. Implement -- use rendering library APIs for annotations and navigation, ensure async cleanup.
  4. Resilience -- add re-anchoring strategy (exact match --> fuzzy text --> chapter fallback --> user notice).
  5. Performance -- lazy-load document assets, reuse single rendition, clean up listeners to avoid leaks.
  6. Testing -- add test cases for locator serialization + re-anchor helpers; capture regressions.

Checklist

  • Position + text excerpt + chapterRef persisted together.
  • Anchor serialization uses stable casing + schema.
  • Re-anchoring warns user when falling back.
  • Event handlers removed on unmount.
  • Telemetry events logged for load failures with trace IDs.

See Also

  • reader-ui-ux — Reader/admin UI with responsive layouts
  • turso-db — Database for document storage

Rationalizations

RationalizationReality
"Exact match anchoring is always sufficient"Documents change formatting across versions; multi-signal fallback prevents total anchor loss.
"Lazy loading complicates the code"Eager loading wastes memory and blocks rendering; lazy loading is essential for large documents.
"Telemetry for load failures is overkill"Without telemetry, silent anchor failures are invisible until users report them.

Red Flags

  • Relying on a single anchoring signal without fallback strategy
  • Not cleaning up event handlers on unmount
  • Skipping locator serialization tests

References

  • references/locator-patterns.md - Document locator strategies
  • references/anchoring.md - Annotation anchoring techniques

Voice & Context

  • Default: professional + blog
  • Reference: voice-profiles skill for definitions and auto-detection.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free