Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for how to set up the .marimo.toml file #2922

Open
1 of 4 tasks
meliz19 opened this issue Nov 21, 2024 · 2 comments
Open
1 of 4 tasks

Add documentation for how to set up the .marimo.toml file #2922

meliz19 opened this issue Nov 21, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@meliz19
Copy link

meliz19 commented Nov 21, 2024

Documentation is

  • Missing
  • Outdated
  • Confusing
  • Not sure?

Explain in Detail

The Package Management section of the Docs state that users can choose from a variety of package managers to install packages. I use poetry in most of my projects, so I opted to use the .marimo.toml file to set the package manager. This was a painful endeavor as I had to read through the source code to figure out the expected layout of the .marimo.toml file.

Your Suggestion for Changes

It would be very helpful if documentation could be added to the Docs regarding how to set up the .marimo.toml file if users desire to take advantage of it.

@meliz19 meliz19 added the documentation Improvements or additions to documentation label Nov 21, 2024
@meliz19
Copy link
Author

meliz19 commented Nov 21, 2024

For those wanting to use the .marimo.toml option, here's the link to the default configs.

@akshayka
Copy link
Contributor

Thanks for the issue; we have it on our roadmap to improve the configuration experience (including documentation).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants