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

fix: marimo islands (Windows-related) + doc touchups #3242

Merged
merged 14 commits into from
Jan 2, 2025

Conversation

Haleshot
Copy link
Contributor

@Haleshot Haleshot commented Dec 19, 2024

📝 Summary

Will be improving docs for islands soon (if that's alright); I believe islands based implementations (conversions, etc) can be elaborated on. Fix windows-based issues too.

🔍 Description of Changes

📋 Checklist

  • I have read the contributor guidelines.
  • For large changes, or changes that affect the public API: this change was discussed or approved through an issue, on Discord, or the community discussions (Please provide a link if applicable).
  • I have added tests for the changes made.
  • I have run the code and verified that it works as expected.

📜 Reviewers

@akshayka OR @mscolnick

Copy link

vercel bot commented Dec 19, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
marimo-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 2, 2025 7:50pm
marimo-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 2, 2025 7:50pm

Copy link

vercel bot commented Dec 19, 2024

@Haleshot is attempting to deploy a commit to the marimo Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

@akshayka akshayka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a round of comments

marimo/_islands/island_generator.py Outdated Show resolved Hide resolved
marimo/_islands/island_generator.py Outdated Show resolved Hide resolved
marimo/_islands/island_generator.py Outdated Show resolved Hide resolved
docs/guides/exporting.md Outdated Show resolved Hide resolved
docs/guides/exporting.md Show resolved Hide resolved
marimo/_islands/island_generator.py Show resolved Hide resolved
@Haleshot
Copy link
Contributor Author

Haleshot commented Jan 2, 2025

Any reason (cost, etc.) for mkdocs-vercel deploy to require authorization now? Don't think this was there before the migration from furo-sphinx to mkdocs. Just that, I rely on the deployment to see how the docs pans out (especially when using mkdocs-specific syntax and features - tabs, etc) as developing on windows, the make docs (contributing guide for docs) causes issues in creating docs locally.

!!! example

/// tab | Using uv run

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's delete this section on uv run

docs/guides/exporting.md Outdated Show resolved Hide resolved
docs/guides/exporting.md Outdated Show resolved Hide resolved
docs/guides/exporting.md Outdated Show resolved Hide resolved
docs/guides/exporting.md Outdated Show resolved Hide resolved
docs/guides/exporting.md Outdated Show resolved Hide resolved
@Haleshot
Copy link
Contributor Author

Haleshot commented Jan 2, 2025

Removed the uv run block (though I thought it would be good to show instructions on using the uv run command for islands). Also, I hope I resolved the admonition (it seemed to be an indent issue).

Copy link
Contributor

@akshayka akshayka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thanks again for the Windows fix :)

@akshayka akshayka merged commit f25bdf6 into marimo-team:main Jan 2, 2025
30 checks passed
Copy link

github-actions bot commented Jan 2, 2025

🚀 Development release published. You may be able to view the changes at https://marimo.app?v=0.10.10-dev8

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.

3 participants