Skip to content

docs: clarify deferred persistence terminology#1733

Merged
RodrigoVillar merged 1 commit intomainfrom
rodrigo/clarify-deferred-persistence-terminology
Mar 6, 2026
Merged

docs: clarify deferred persistence terminology#1733
RodrigoVillar merged 1 commit intomainfrom
rodrigo/clarify-deferred-persistence-terminology

Conversation

@RodrigoVillar
Copy link
Contributor

@RodrigoVillar RodrigoVillar commented Mar 3, 2026

Why this should be merged

Closes #1689

How this works

  • Adds documentation which describes the relationship between commits, persists, and permits.
  • Moves mermaid diagram to PersistWorker documentation, enabling it's usage with aquamarine.

How this was tested

CI + generated documentation for the PersistWorker:

Screenshot 2026-03-05 at 14 32 11

Breaking Changes

  • firewood
  • firewood-storage
  • firewood-ffi (C api)
  • firewood-go (Go api)
  • fwdctl

@RodrigoVillar RodrigoVillar self-assigned this Mar 3, 2026
@RodrigoVillar RodrigoVillar changed the base branch from main to rodrigo/replace-persist-semaphore-with-channel-condvar March 3, 2026 16:42
@RodrigoVillar RodrigoVillar changed the title Rodrigo/clarify deferred persistence terminology docs: clarify deferred persistence terminology Mar 3, 2026
@RodrigoVillar RodrigoVillar force-pushed the rodrigo/replace-persist-semaphore-with-channel-condvar branch from b72ad76 to 4c33dee Compare March 4, 2026 17:37
@RodrigoVillar RodrigoVillar force-pushed the rodrigo/clarify-deferred-persistence-terminology branch from ea78d45 to b95c6b0 Compare March 4, 2026 21:05
@RodrigoVillar RodrigoVillar force-pushed the rodrigo/replace-persist-semaphore-with-channel-condvar branch 5 times, most recently from f7d32d7 to 2242401 Compare March 5, 2026 19:03
@RodrigoVillar RodrigoVillar force-pushed the rodrigo/clarify-deferred-persistence-terminology branch from b95c6b0 to 90c9fd8 Compare March 5, 2026 19:14
Base automatically changed from rodrigo/replace-persist-semaphore-with-channel-condvar to main March 5, 2026 19:15
@RodrigoVillar RodrigoVillar force-pushed the rodrigo/clarify-deferred-persistence-terminology branch from 90c9fd8 to 9f29c24 Compare March 5, 2026 19:16
@RodrigoVillar RodrigoVillar marked this pull request as ready for review March 5, 2026 19:34
@RodrigoVillar RodrigoVillar merged commit c443887 into main Mar 6, 2026
49 checks passed
@RodrigoVillar RodrigoVillar deleted the rodrigo/clarify-deferred-persistence-terminology branch March 6, 2026 11:55
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.

Better document the relationship between persist, commit, and permits

2 participants