API docs should link to the code definition in github for each function

[KyleAMathews]

Right now if you go to an action e.g. https://www.gatsbyjs.org/docs/actions/#createPage there's no link to the actual code definition at

gatsby/packages/gatsby/src/redux/actions.js

Line 111 in 026eaaa

actions.createPage = (

Documentation is great but sometimes you can get more clarity by looking at the code itself.

[JacobBlomgren]

@KyleAMathews I can do it! Should it be a text link or the github icon link used in other places in the docs?

[KyleAMathews]

@pieh might actually already have handled this in a different PR he was already working on.

[pieh]

The UI design is TBD (I didn't work on this part)

For actions reference page:

I just added support for providing code location in c81f6e0 (it's in not yet merged PR #11597)

After that is merged we can adjust query in https://github.com/gatsbyjs/gatsby/blob/master/www/src/pages/docs/actions.js#L73-L82 to use codeLocation to construct github links that always point to accurate position in github

For Gatsby Node/SSR/Browser API reference pages:

I've done proof of concept parser that finds where we "call" APIs - https://gist.github.com/pieh/ccbf0b2556fe3d19202ddaf61b881937 :

• there is example output in gist as well - I just ran this on older branch so hightlighted lines are outdated in some cases
• it doesn't find gatsby-browser API calls because I didn't handle ESM imports in my parser implementation
• this should be turned into gatsby plugin (I think local plugin for .org site), so data can be used on .org site

[gatsbot]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.

If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!

Thanks for being a part of the Gatsby community! 💪💜