You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
akshayka
merged 2 commits into
marimo-team:main
from
rparkr:rp/fix-links-ai-completionOct 2, 2024
Conversation
This file contains 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
I also masked the API key in the screenshots -- previously it was a fake API key, but resembled an actual key. Abbreviating the key with ... eliminates that confusion.
🔍 Description of Changes
I updated the src attributes in the <img> tags to point to the /_static directory (using an absolute path)
I verified that the images load correctly by building from source and running make ARGS="-a" docs as shown in the contributor guide (thanks for that helpful guide!). See the after screenshot below.
I updated the screenshots to mask out the API key. Previously it was a fake API key I generated using Python's uuid.uuid4(). Masking out the (fake) API key eliminates confusion.
I formatted the HTML tags in the markdown page to match the formatting used in other pages in the docs
I added figcaptions to the screenshots, following the pattern used in other areas of the docs
After
Before
Notes on dark-theme screenshots
If you'd prefer to use the dark-theme images in the screenshots instead, you can add -dark.png to the end of the src image paths; the dark-theme screenshot is also updated with the API mask. I chose the light-themed versions because the screenshots in other areas of the docs use a light theme.
Also, feel free to delete the dark-themed images if there isn't a use for them, since that would keep the _static directory smaller.
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 did not make any changes to the code besides the docs)
I have run the code and verified that it works as expected.
- fix links to screenshots
- replace screenshots with updated versions that obfuscate the API key (which was a fake API key before, but still looked real. Now it's less confusing)
- Also, format the HTML to match formatting used in other docs pages
- Use absolute paths from the /_static directory so that links will work when the docs are built
Aha, thankful to come across this :) Was experimenting with Ollama models with marimo (in the AI Completion docs) and noticed the images rendering incorrectly as shown in the screenshots above!
Had noted it down as an issue myself (in my personal TODO) and was going to raise a PR for this today!
Aha, thankful to come across this :) Was experimenting with Ollama models with marimo (in the AI Completion docs) and noticed the images rendering incorrectly as shown in the screenshots above! Had noted it down as an issue myself (in my personal TODO) and was going to raise a PR for this today!
Thanks @Haleshot! I appreciate the encouragement :) I'm just getting started on my journey in open source contributions, and the encouragement means a lot.
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
Fixes broken image links in #2458.
I also masked the API key in the screenshots -- previously it was a fake API key, but resembled an actual key. Abbreviating the key with
...eliminates that confusion.🔍 Description of Changes
srcattributes in the<img>tags to point to the/_staticdirectory (using an absolute path)make ARGS="-a" docsas shown in the contributor guide (thanks for that helpful guide!). See the after screenshot below.uuid.uuid4(). Masking out the (fake) API key eliminates confusion.figcaptions to the screenshots, following the pattern used in other areas of the docsAfter
Before
Notes on dark-theme screenshots
If you'd prefer to use the dark-theme images in the screenshots instead, you can add
-dark.pngto the end of thesrcimage paths; the dark-theme screenshot is also updated with the API mask. I chose the light-themed versions because the screenshots in other areas of the docs use a light theme.Also, feel free to delete the dark-themed images if there isn't a use for them, since that would keep the
_staticdirectory smaller.📋 Checklist
📜 Reviewers
@mscolnick