devdocs icon indicating copy to clipboard operation
devdocs copied to clipboard

Add support to include links to the source code if available

Open genotrance opened this issue 7 years ago • 2 comments

Using the Nim documentation as an example, check out this link.

You can see that every method, variable or constant has a link directly to the source code in github.com. This makes it very easy to look at the actual implementation.

Other random languages I just checked. These also have such links handy.

Crystal Elixir Rust

Having access to the implementation by link in devdocs will make it super useful. Without it, I end up using the language docs even though devdocs is much cooler.

As an aside, I see you have a link to the original doc page that was scraped at the bottom so in theory I could click on that, find the function again and then click there. But most docs also have a permalink to each entry. It would be beneficial to include this permalink within devdocs as well so you could jump to the official documentation from right there.

Ideally, we have both these links handy within devdocs so there's no reason to go to the official docs.

genotrance avatar Feb 28 '18 19:02 genotrance

100x this. I love devdocs, it's always a fixed tab in my Chrome, but the lack of the link to the actual source code in Github makes me use the Rails documentation instead of devdocs.

feliperaul avatar Jun 13 '21 16:06 feliperaul

@genotrance, all the documentation you mentioned have links to the source code, check them out and let me know if changes are needed.

@feliperaul Rails will have the links soon.

MasterEnoc avatar Jun 23 '21 04:06 MasterEnoc