Skip to content

docs: soften delegate 'backups and replicas' claim#44

Open
iduartgomez wants to merge 1 commit into
mainfrom
docs/4037-soften-delegate-backup-claim
Open

docs: soften delegate 'backups and replicas' claim#44
iduartgomez wants to merge 1 commit into
mainfrom
docs/4037-soften-delegate-backup-claim

Conversation

@iduartgomez
Copy link
Copy Markdown
Contributor

Problem

The use-cases section of the delegates manual page currently states:

Delegates can also synchronize with identical delegate instances running on other devices the user controls. With an appropriate shared secret, they communicate securely via Freenet and act as backups and replicas of each other.

This misleads users about durability guarantees. Cross-device synchronization is not implemented — PR #4034 added local snapshot history only. The vault-delegate primitive for cross-device sync is tracked in freenet/freenet-core#3050 and is still planned/aspirational.

Solution

Replace the inaccurate paragraph with an accurate description:

  • Delegates store their state encrypted on the local device.
  • Recent prior values are kept as snapshots so accidental overwrites can be recovered.
  • Cross-device synchronization is not yet implemented, with a link to freenet-core#3050 for the planned vault-delegate primitive.

The replacement matches the existing tone and Hugo markdown style of the page.

Reference

Tracked in freenet/freenet-core#4037.

The use-cases section previously stated that delegates 'act as backups
and replicas of each other' across devices. This is aspirational: no
cross-device sync exists today. PR #4034 added local snapshot history
but not cross-device synchronization.

Replace the inaccurate sentence with an accurate description:
- delegates store state encrypted on the local device
- recent snapshots allow recovery from accidental overwrites
- cross-device sync is not yet implemented

Link to freenet-core#3050 (vault-delegate primitive) for the planned
implementation. Fixes freenet/freenet-core#4037.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant