docs/security: file:line citations and the measurement note are out of date

Open Beginner friendly
  • Is something wrong?
#1,722 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
74/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
bash, shell
Domain
documentation

Research direction

Start with docs/security.md, the canonical English file, and verify each measurement against the named source files and functions, including scripts/internal/remote-sync.mjs, scripts/remote.sh, scripts/internal/sync-cipher.mjs, docs/design/remote-sync.md, and docs/spec/ref/age-v1-profile.md. Update the stale claims and replace drifting line citations with function names or pinned commits, then bring docs/security.ja.md into sync. Done when the measurements and citations match the sources.

Written by the indexing model from the issue text.

Description

docs/security.md and docs/security.ja.md cite source locations as file:line, and the citations have drifted since they were written.

What is stale

  • The measurement note says it was taken on integration/remote at commit 452da72 and that the only files that branch changes are the two security docs. Neither is true any more.
  • Many file:line citations point at the wrong lines. Examples found while reading (current line in parentheses): scripts/internal/remote-sync.mjs:1686 (now about 2371), :1699 (about 2384); scripts/remote.sh:1280 (about 1697), :1758 (about 2381), :1076 cmd_unlock (about 1489), :1729 _remote_configure_keyed_team (about 2348); scripts/internal/sync-cipher.mjs:718-725 openEnvelope (about 792), :277-281 (about 317); docs/design/remote-sync.md:83-85 (about 87); docs/spec/ref/age-v1-profile.md:342-345 does not match the quoted sentence. The server/src/ citations still match.
  • sync-cipher.mjs is described as 819 lines; it is 893.
  • "last touched on 2026-07-27, by commit 1a56d8e" for docs/spec/ref/age-v1-profile.md is out of date (last touched 2026-09-16).

Proposed fix

Re-measure the claims, then cite function names (or a pinned commit) instead of line numbers, so the citations survive edits. The English file is canonical; the Japanese file follows it.

Not urgent for 1.6.0; tracked here so it is done after GA.

Dominant language
Shell
Stars
1.5k
Forks
156
Avg merge
16h 32m
Merged PRs (30d)
213

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from fujibee/agmsg

All issues in fujibee/agmsg

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.