Repository navigation
Rewrites the README as an introduction - #241
Merged
Merged
Conversation
The README now reads as a What, a Why, the install line, one basic usage block set in the library loan, a Documentation map grouped by the reader's question, and a Compatibility section; it drops from 337 lines to 112. The short-program snippets (execute/3, execute_value/3 and :protected_roots) and the editor-vocabulary snippets move into the language reference, which the docs examples test already doctests. The host-embedding recipe, the = migration note and the siblings section are covered by the custom functions guide, the language reference and the architecture page, which the map links. Refs: px-sm34
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
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.
Rewrites the README as an introduction to the package: what it is, why it exists, how to install it, one basic usage block, a map of the documentation grouped by the reader's question, and what it is compatible with. No file under
lib/orsrc/changes.What changed
eval). No history, no predecessor, no date.{:predicator, "~> 9.4"}.test/docs_examples_test.exsstill readsREADME.md.The README goes from 337 lines to 112 (
wc -l, base and head).Unchanged except
Every H2 the old README had, by
grep '^## 'base to head, and where its text now lives:Installation,Documentation,License: kept (Documentation rewritten as the grouped map).Quick Start: replaced byBasic usage, re-set in the library loan.A worked example: an authorization rule: its compile-once, error-value and positions material is in the basic usage block and in the existing embedding guide (choose a compile function, store the instruction list, runtime errors and positions). Its short-program subsection (execute/3,execute_value/3,:protected_roots) moves to the language reference as "Running a program from Elixir", re-set in the library loan; that page is already doctested bytest/docs_examples_test.exs, so the snippets stay executed.Embedding Predicator in a host application: the provider, host slot,put_host/2and serializable-context material already lives in the custom functions guide and the embedding guide, both linked under Do. Its editor-completion subsection moves to the language reference as "The vocabulary for an editor", with its snippets, under the same doctest.Migrating from =: covered by the language reference's=note and the architecture page's grammar-break section; the record is linked under Understand.Cross-Language Siblings: covered by the architecture page's section of the same name (linked under Understand) and the porting guide (linked under Do).Development: becomesContributing.The AST reference is linked by absolute GitHub URL because the package tarball does not ship it (the doc links stage refuses a relative README link to an unpackaged file); every other page link is relative, as before.
ex_quality and the README stage
The acceptance turns the README stage on only where ex_quality 0.16.0 is on Hex. It is not (Hex's latest is 0.15.1), so this PR takes the acceptance's fallback: the ex_quality dev dependency and
.quality.exsare untouched, and turning the stage on atseverity: :erroris left as follow-up work.Checks
readme-lint.rb README.md --manifest .claude/diataxis.md:readme-lint.rb README.md(no manifest):mix qualitygreen on the committed tree: Format, Compile, Doc links, Dependencies, Docs, Credo, Dialyzer and Tests (2,914 of 2,914, 95.5% coverage); Doctor, Gettext and Sobelow skipped as not installed, the repo's expected state.test/docs_adr_links_test.exsgreen: the README keeps its absolute links to the two numbered records it cited before.doctest README.md (1)red on the assertion; restored byte-equal and green.changelog.d/README.mdexcludes documentation.Direction check
This PR carries no record text: no ADR is added, edited or cited anew. The map's claims were checked against the pages they link at the head: each anchor (
#running-a-program-from-elixir,#the-vocabulary-for-an-editor,#cross-language-siblings,#check-the-isa-version-before-you-run-a-stored-program) lands on the section its line names.