search

NWChemEx / .github

GitHub Settings for the NWChemEx Organization
https://nwchemex.github.io/.github/
Apache License 2.0
1 stars 2 forks source link

Adds "edit on GitHub" to documentation #125

Closed ryanmrichard closed 8 months ago

ryanmrichard commented 8 months ago

When reading documentation on the internet one often thinks of little edits that could make the documentation better. To lower the barrier to making such edits this PR modifies the HTML documentation so that all pages have an "edit on GitHub" link. When a user clicks this link they'll be taken directly to an editor on GitHub with the source for that page. They can then make their changes, and launch a PR with those changes.

This came about because I wanted to add an additional resource to our "Recommended Development Resources" for generating ASCII file system diagrams. So in addition to modifying the configuration of the documentation, this PR also adds that link and description.

ryanmrichard commented 8 months ago

Any other reviewers interested?

ryanmrichard commented 8 months ago

🚀 [bumpr] Bumped! New version:v0.3.23 Changes:v0.3.22...v0.3.23