Skip to content

doc: add "Edit on GitHub" link

Rodrigo Muino Tomonari requested to merge github/fork/Trott/edit-on-github into master

Proof of concept for an "Edit on GitHub" link, inspired by the Serverless docs.

One issue is that the link is to the version of the docs on the master branch even if the person was reading a different version of the doc. I don't consider that a big problem, although we can always remove the link if it turns out to be a big problem. I don't think there is a good solution. PRs need to be opened against the master branch generally. Having a bunch of PRs against staging branches is probably not what we want. If there's an update to one version of the doc, there will usually be an update to other versions.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines

Merge request reports