I am sure this has been asked before, but I was not able to find it here or in the Documenter issues: Is there a way to include a link back to the main repository on each page of Documenter.jl? I know that there’s the Edit on GitHub link but that always takes me to the documentation source, requiri…

There isn’t at the moment, but I have a WIP PR for just that . Unfortunately, it ended up being a non-trivial amount of refactoring to get it work right, so I quite haven’t had the time to wrap it up yet.

Agreed. [image] Plea to package developers regarding documentation! Community Very serious topic ahead: Please please please can package developers put a link BACK to the source repo inside your documentation! Without it, the documentation becomes a trap. Randomly selec…

I agree. As a package user and landing to a new package documentstion page, one of the most frequent things I want to do is to go to the main github package page. As a package developer, what I did is to manually add a link to it on top of my main documentation home page.

[image] sylvaticus: As a package developer , what I did is to manually add a link to it on top of my main documentation home page. Haha, same here ! [image] mortenpi: There isn’t at the moment, but I have a WIP PR for just that . Unfortunately, it ended up being a non-trivial amount of ref…

[image] sloede: [image] mortenpi: There isn’t at the moment, but I have a WIP PR for just that . Unfortunately, it ended up being a non-trivial amount of refactoring to get it work right, so I quite haven’t had the time to wrap it up yet. Wow, I have completely missed that, sorry. Is there…

Thanks for the overview. I had a look at the PR to see how hard it would be to factor out (2), but it seems that any meaningful contribution from my side at this point exceeds my time budget :-/, mostly since essentially everything is new for me…

Link back to main repo on each page in Documenter.jl

General Usage

tbeason March 18, 2021, 6:40am 3

Agreed.

Topic		Replies	Views
Plea to package developers regarding documentation! Community documenter	9	1162	April 13, 2020
A suggestion for package maintainers Community package , suggestions	2	911	August 2, 2020
How to see doc page of GitHub PR General Usage documentation , github	4	469	October 27, 2023
PSA: Linking to Package Documentation in GitHub Repos Community package , documentation	3	424	March 9, 2024
Links to the source in the documentation General Usage documenter	7	766	June 8, 2022

Link back to main repo on each page in Documenter.jl

Related topics