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.

Sign up for GitHub

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

Jump to bottom

Show Link to the Trio (main project) GitHub repository instead of TrioDocs (trio-docs) #92

Open
ebouchut opened this issue Oct 30, 2024 · 0 comments · May be fixed by #93
Open

Show Link to the Trio (main project) GitHub repository instead of TrioDocs (trio-docs) #92

ebouchut opened this issue Oct 30, 2024 · 0 comments · May be fixed by #93

Comments

@ebouchut
Copy link
Contributor

Why

[...] The main repo needs the prominent spot because we are talking about it. And if we can add a docs repo link somewhere we should (maybe a help with the docs link?)

See: this conversation on Discord

Description

This PR replaces the link to the GitHub repository: now nightscout/Trio (the Trio Project/Code) instead of nightscout/trio-docs (TrioDocs).

Solution

The Material for Mkdocs theme displays the link to the GitHub repository using a partial (i.e., an HTML snippet).
Overriding the theme provides a quick and easy fix to display the link to the Trio project.
I overrode the Material theme template (material/templates/partials/source.html) with
the override/partials/source.html file containing a link to the nightscout/Trio GitHub repository.
ebouchut added a commit to ebouchut/trio-docs that referenced this issue Oct 30, 2024
@ebouchut
📝 Show a link to Trio GitHub repo instead of TrioDocs
0ba9acb 
Use nightscout/Trio instead of `nightscout/trio-docs`
The overriden template is used in the header, footer and navigation
(on small screens).
Fixes nightscout#92
ebouchut added a commit to ebouchut/trio-docs that referenced this issue Oct 30, 2024
@ebouchut
📝 Show a link to Trio GitHub repo instead of TrioDocs
4cf0463 
Use nightscout/Trio instead of `nightscout/trio-docs`
The overridden template is used in the header, footer and navigation
(on small screens).
Fixes nightscout#92
@ebouchut ebouchut linked a pull request Oct 30, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

📝 Display a link to the Trio GitHub repository instead of TrioDocs ebouchut/trio-docs
1 participant
@ebouchut