Annotate documentation omits per-file version history and privacy controls
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- documentation
Research direction
Read apps/marketing/src/content/docs/commands/annotate.md and apps/marketing/src/content/docs/reference/environment-variables.md, using packages/server/annotate.ts, packages/shared/storage.ts, and packages/shared/config.ts to verify the documented behavior. Add the per-file history, retention, storage, privacy controls, and excluded input modes, then run bun run build:marketing, bun run typecheck, and git diff --check.
Written by the indexing model from the issue text.
Description
Summary
The public annotate command documentation explains supported files, URLs, folders, and review-gate behavior, but it does not explain the existing per-file version history for eligible local files, its retention, or how to disable it.
Current documentation
The annotate page does not tell users that opening a non-empty local markdown, text, or HTML file saves a history copy before the UI opens. It also omits the storage and active configuration locations, deduplication behavior, file-path identity, raw HTML versus --markdown history content, Version Browser integration, retention, opt-out precedence, and the input modes excluded from this history.
Shipped behavior
- Non-empty local single-file
.md,.mdx,.txt,.html, and.htmsessions are eligible to save history on open. - History is keyed by the resolved file path, so reopening the same path can show the previous/current diff and earlier versions in the Version Browser.
- Consecutive identical content is deduplicated.
- Raw HTML annotation stores the HTML source in history; using
--markdownstores the converted markdown content instead. - Copies are stored indefinitely under
~/.plannotator/history/by default, or underhistory/insidePLANNOTATOR_DATA_DIR, until the user manually deletes them. - The active config file is
~/.plannotator/config.jsonby default orconfig.jsoninsidePLANNOTATOR_DATA_DIRwhen that variable is set. - Users can disable annotate history with
PLANNOTATOR_ANNOTATE_HISTORY=0or"annotateHistory": falsein the active config file. The environment variable takes precedence over config. - URL annotation, folder browsing, and last-message annotation do not use per-file version history.
Impact
Without this documentation, users can miss a useful iteration feature and may incorrectly assume local file annotation is stateless. The omission is especially relevant for users reviewing sensitive documents who need to understand what content is copied, where it is stored, how long it remains, and how to opt out.
Proposed scope
Add a focused per-file version history section to apps/marketing/src/content/docs/commands/annotate.md and document the environment variable in apps/marketing/src/content/docs/reference/environment-variables.md. This is a documentation-only contribution describing behavior already present in Plannotator 0.24.1; it does not change runtime behavior or introduce new gate behavior.
Evidence
- The implementation is defined by annotate history setup in
packages/server/annotate.ts, history storage and deduplication inpackages/shared/storage.ts, and configuration resolution inpackages/shared/config.ts. - The contribution was rebased onto
upstream/mainat2594b374(Plannotator 0.24.1). - Focused validation on 2026-07-20 passed:
bun run build:marketinggenerated 40 pages,bun run typecheckpassed, andgit diff --checkpassed. - No live browser session was run because the contribution changes documentation only.
Contribution
I have a documentation-only update ready to contribute. About to do the last checks and push the PR => Done!
- Dominant language
- TypeScript
- Stars
- 8.7k
- Forks
- 649
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 114
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from backnotprop/plannotator
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
backnotprop/plannotator#1503 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
backnotprop/plannotator#1502 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
backnotprop/plannotator#1359 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
backnotprop/plannotator#1069 ·
-
accepted enhancement triage
Difficulty 5/5 Over a week Newbie friendliness 25/100
backnotprop/plannotator#1583 ·
All issues in backnotprop/plannotator
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100