add authors.rst to repo and hide link on About page

ORNL / intersect-architecture

https://intersect-architecture.readthedocs.io

Creative Commons Attribution 4.0 International

2 stars 0 forks source link

add authors.rst to repo and hide link on About page #19

Open naughtont3 opened 1 month ago

naughtont3 commented 1 month ago

Note, i find it helpful to have the "authors" file for quick reference on syntax details. If others agree this is useful, this PR carries that file over to the new github repo. If not, feel free to close this PR.

engelmannc commented 1 month ago

The Document Authors Guide was excluded from the Web-based INTERSECT Architecture documentation for multiple reasons:

Why include any of this here? The customer for the Web page is not interested in this.
If needed, we can add info to the repo (Contributing or Wiki).
There are lots of other resources out there that teach RST.

naughtont3 commented 1 month ago

Note - we will not merge this PR but instead will create a top-level contributings file that also points at a subdir for other "maintenance" items that will not be linked on the web, but instead will just live in the git repo. It should contain things like this authors guidelines (in MD) and other workflow/maintenance procedures for maintaining the doc that are easier to see in the git repo directly than say a wiki.

See Issue #21