Repository navigation
docs(run): recommend a git-ignored folder beside code and sync the git warning - #668
Merged
Merged
Conversation
aicayzer
marked this pull request as ready for review
October 27, 2026 02:08
aicayzer
enabled auto-merge (squash)
October 27, 2026 02:08
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.
Summary
Adds a recommended practice to Sync a folder: for reference records kept beside code, use a folder inside the repository that git ignores, named
marfa/, and says why. It also syncs the contract from withmarfa/marfa, which adds the git warning ofmarfa folders add. This pull request waits on withmarfa/marfa#2417, which adds the warning and its contract statements.Changes
content/docs/run/sync-a-folder.mdx: after the storage warning sentence, a paragraph that recommendsmarfa/(not.marfa, which every folder already holds for its store andfolder.yaml), says any directory works elsewhere, and explains that git and Marfa would both change the same files, sofolders addwarns and goes on.scripts/sync-from-marfa.shoutput, run against the branch of feat(cli): warn when git tracks the directory of a folder being added marfa#2417: the contract index gainsfolders/git-tracked-warns,folders/git-tracked-continuesandfolders/git-untracked-silent. The same run also carried the file-text search statements, the v0.0.39 release and its download and image lines that were already on marfa'smain.folder-safeguards,keep-folders-running,folder-filesand the glossary do not mention storage warnings or git, so none contradicts the new paragraph.Testing
pnpm test: 39 files, 709 tests passed (content lint and the command check included).pnpm buildandpnpm types:check(CI runs them).scripts/sync-from-marfa.shagainst marfamainonce feat(cli): warn when git tracks the directory of a folder being added marfa#2417 has merged, so the generated files matchmainand not the branch.Notes for reviewers
COMMANDS.md, whosefolders addhelp text changes there.mainonly by the commit hashes of the contract index entries it carries.Checklist