Repository navigation
Docs: make the README, CONTRIBUTING and package description accurate - #73
Merged
Merged
Conversation
The README called the library a pure core with IO confined to storage and the server, but NAR tree serialization and restore, file hashing and the codecs' decompress functions all run in IO. It now says which parts are pure. The cabal synopsis and description drop "pure-first" for the same reason; Hackage shows them from the next release. Other corrections: the install snippet gains the PVP bounds and the sublibrary syntax that dependents actually need, the streaming example imports Data.ByteString itself, the server table lists --store, and the public cache section says what the cache holds and where nix.conf must set it for a multi-user Nix to use it. Both build instructions now give the command CI runs, with the server flag and -Werror, and CONTRIBUTING names the ormolu and hlint versions CI pins. The HTML header and footer become plain Markdown.
aoinoikaz
force-pushed
the
docs-readme-accuracy
branch
from
October 8, 2026 21:12
de28f93 to
2831d24
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings the README, CONTRIBUTING and the cabal synopsis and description in line with the code. Based on #72, since both edit CONTRIBUTING; GitHub retargets this to main when #72 merges.
NovaCache.NARhas 20 IO-typed signatures (withNarSourceand the tree functions),Hash.hashFile :: FilePath -> IO NixHash, andBzip2.decompressandZstd.decompressreturn IObuild-depends: nova-cachenova-cache >= 0.11 && < 0.12, plus the sublibrary formnova-cache:{nova-cache, xz, ...}Data.ByteStringNIX_CACHE_DIRrow--storeexe/Main.hs:95cabal build/cabal test-f serverand-Werrorci.ymlbuild jobtested-with,ci.yml:83CONTRIBUTING also names ormolu 0.9.0.0 and hlint 3.10, the versions
ci.ymlpins. The HTML header and footer become plain Markdown, and the dash substitutes are gone.Checks
cabal check: no errors or warnings.