docs: document pull and add the baseline export + zero-diff demo step - #74
Draft
Kiran01bm wants to merge 1 commit into
Draft
docs: document pull and add the baseline export + zero-diff demo step#74Kiran01bm wants to merge 1 commit into
Kiran01bm wants to merge 1 commit into
Conversation
Onboarding an existing database is pull → commit → diff = zero; the docs and the demo tour now show that loop end to end against the built binary.
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.
Document
pg-sprite pulland add a baseline-export + zero-diff verification step to the demo tour.Why
The pull CLI landed without a user-facing doc, so the intended onboarding loop — export a live schema, then prove
diffagainst the export is empty — existed only in the PR that added the command. Users adopting pg-sprite on an existing database need that loop spelled out and demonstrated, not inferred from--help.What
docs/pull.md: what pull enumerates, per-table results (not fail-fast), the refusal set, and the export →diff --jsonzero-statement verification loop; linked fromREADME.mdanddocs/README.md.docs/cli-output-examples.md: an executed pull example.demo/tour.sh:run_pullruns pull, asserts the file count, then assertsdiff --jsonreturns zero statements; exposed as apulltour mode and described indemo/README.md.Before / after