Skip to content

docs: suggest refined github - #1155

Open
jacopoabramo wants to merge 4 commits into
napari:mainfrom
jacopoabramo:docs/refined-github-tip
Open

jacopoabramo wants to merge 4 commits into
napari:mainfrom
jacopoabramo:docs/refined-github-tip

Conversation

@jacopoabramo

Copy link
Copy Markdown

References and relevant issues

Description

Since I discovered refined github, might as well mention this in the documentation as it changed my life and now I don't even know how I could have lived without it.

It just adds a small tip referencing the github project. I might provide a link directly to their installation process though.

image

@jacopoabramo
jacopoabramo requested a review from TimMonko October 2, 2026 10:25
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 2, 2026

@brisvag brisvag left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

How about using a side margin note? I feel like we could use these more, for stuff that's really just a "btw..." kinda message.

@jacopoabramo

Copy link
Copy Markdown
Author

Hmmm how would that look like?

@TimMonko

TimMonko commented Oct 2, 2026

Copy link
Copy Markdown
Member

TIL! https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/theme-elements.html#admonition-sidebars

I might start making good use of this if it looks good in our styling / docs / scrolling. I find admonitions/extra info so helpful but I HATE how it interrupts vertical flow. This might be neat to reapproach our docs with

@jacopoabramo

Copy link
Copy Markdown
Author

This is how it looks like with a sidebar (haven't tried admonition but can render it if you're interested).

image

I must admit I'm not a fan of this. Maybe the text needs to be shorter but I would still prefer the tip approach.

@jacopoabramo

Copy link
Copy Markdown
Author
image

With the admonition the text is too close to the edge of the box. Uh.

@TimMonko TimMonko left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Approving in its current stage. I also agree that the margin version is a bit 😵‍💫

@brisvag brisvag added this to the 0.10.0 milestone Oct 9, 2026
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

Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants