Add EDIT THIS PAGE button to documentation pages

[fulldecent]

Regarding documentation pages like this: https://docs.ethers.io/v5/getting-started/.

These pages could be improved by adding an "EDIT THIS PAGE" link that directly links to, for example, https://github.com/ethers-io/ethers.js/edit/master/docs/v5/getting-started/index.html

This will reduce friction for people finding and fixing typos and then bring those people in to contribute more improvements to documentation.

[ricmoo]

Keep in mind that link is to the generated source, not the documentation source. After changes, it is necessary to rebuilt the documentation using flatworm, which re-runs all code samples and few other things and then re-upload the content.

I like the idea, but it would be a lot of work to add an “edit this page” feature. I could look into adding a slimmer way to mark content as wrong or make suggestions, like Medium notes.

I’ll move this to “Ideas” for more discussion. :)

[fulldecent]

How about an "Edit this page" button that just links to this page every time: https://github.com/ethers-io/ethers.js/tree/master/packages

It seems that is the basis of where documentation comes from.

If that's wrong then I am several years into this project and still don't understand how documentation works.

[ricmoo]

If you are familiar with the Sphinx or other documentation generation systems, Flatworm is similar. There is document source code and a tool that compiles it into various types of HTML, Jekyll Markdown and PDFs. Additional generators are possible too.

The documentation source is kept here: https://github.com/ethers-io/ethers.js/tree/master/docs.wrm

The tool to build the docs (use npm build-docs) is here: https://github.com/ricmoo/flatworm

Which places the output in the /docs/ folder (although I don not check this is often, and may remove the checked in docs in the future).

The output is hosted here: https://docs.ethers.io

[fulldecent]

Awesome, thank you. Recommending to update documentation to say EDIT THIS PAGE and link directly to this URL (regardless of which page you come from) https://github.com/ethers-io/ethers.js/tree/master/docs.wrm