Skip to content

docs(run): recommend a git-ignored folder beside code and sync the git warning - #668

Merged
aicayzer merged 2 commits into
mainfrom
docs/folders-git-warning
Oct 27, 2026
Merged

aicayzer merged 2 commits into
mainfrom
docs/folders-git-warning

Conversation

@aicayzer

Copy link
Copy Markdown
Contributor

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 of marfa 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 recommends marfa/ (not .marfa, which every folder already holds for its store and folder.yaml), says any directory works elsewhere, and explains that git and Marfa would both change the same files, so folders add warns and goes on.
  • scripts/sync-from-marfa.sh output, run against the branch of feat(cli): warn when git tracks the directory of a folder being added marfa#2417: the contract index gains folders/git-tracked-warns, folders/git-tracked-continues and folders/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's main.
  • folder-safeguards, keep-folders-running, folder-files and the glossary do not mention storage warnings or git, so none contradicts the new paragraph.

Testing

Notes for reviewers

Checklist

  • The title is a scoped Conventional Commit.
  • New behavior has a test that was seen failing first, or no test was needed and the reason is above.
  • Docs, comments and the contract still say what is true after this change.

@aicayzer
aicayzer marked this pull request as ready for review October 27, 2026 02:08
@aicayzer
aicayzer enabled auto-merge (squash) October 27, 2026 02:08
@aicayzer
aicayzer merged commit 99aaac8 into main Oct 27, 2026
7 checks passed
@aicayzer
aicayzer deleted the docs/folders-git-warning branch October 27, 2026 02:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant