Repository navigation
Rewrite the README for users who do not know Pi internals - #7
Merged
Merged
Conversation
The old README assumed knowledge of compaction, tokens and thresholds. The new one explains them, documents every setting with its default and an example, and lists recipes and limits. Defaults and warnings match src/config.ts; the soft method follows #4.
HugoLopes45
added a commit
that referenced
this pull request
Oct 6, 2026
The npm page shows the README of the published package. The rewrite from #7 needs a 0.2.1 release, and the release script needs an `Unreleased` entry.
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
1 participant
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.
The old README assumed knowledge of compaction, tokens and thresholds. This rewrite, in ASD-STE100 style:
contextKitsetting with its allowed values, default and an example;Checked against the code:
src/config.tsandextensions/index.ts.softwrites Pi's summary at the extension threshold (Write Pi's summary at the extension's threshold #4). Only[]waits for Pi's own limit.