Skip to content

Add documentation on best practices for .gitignore when using Marimo #7708

@leonoverweel

Description

@leonoverweel

Documentation is

  • Missing
  • Outdated
  • Confusing
  • Not sure?

Explain in Detail

The caching docs currently suggest adding __marimo__/cache/ to .gitignore but to me it seems that things like the JSON files for sessions are also not something I'd want to version control. Should I be completely ignoring all __marimo__ folders or would that break things? It would be good for the docs to be explicit about this.

It would be good for the docs to have explicit guidance on this (beyond the specific caching use case) and maybe for the version control feature page to also have a line about it.

Your Suggestion for Changes

Not sure what the best place is for this, I'm not super familiar with the docs.

Will you submit a PR?

  • Yes

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions