Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revision of irmin-pack readme #2334

Merged
merged 1 commit into from
Sep 19, 2024
Merged

Revision of irmin-pack readme #2334

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/irmin-pack/design/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Irmin-pack design docs
# `irmin-pack` Design Docs

- [Layered store](./layered_store.md), the design document for the first version of garbage collection (GC) that shipped with [Irmin 3.4](https://github.com/mirage/irmin/releases/tag/3.4.0).
- [Chunked suffix](./chunked_suffix.md), the design document for the second version of GC that introduced a chunked suffix for disk space saving during a GC. Introduced in [Irmin 3.5](https://github.com/mirage/irmin/releases/tag/3.5.0).
- [Lower layer](./lower_layer.md), the design document for the third phase of GC that extended it to work for unlimited history stores by archiving instead of deleting data. Will be introduced in Irmin 3.7.
- [Chunked suffix](./chunked_suffix.md), the design document for the GC's second version, which introduced a chunked suffix for disk space saving during a GC. Introduced in [Irmin 3.5](https://github.com/mirage/irmin/releases/tag/3.5.0).
- [Lower layer](./lower_layer.md), the design document for the GC's third phase, extending it to work for unlimited history stores by archiving instead of deleting data. Will be introduced in Irmin 3.7.