Consistent Documentation
Created by: jmgate
@trilinos/framework
Expectations
It'd be great if there was a single, comprehensive set of instructions for interacting with Trilinos.
Current Behavior
At the moment, we have README.md, which people will see rendered when they first navigate to Trilinos on GitHub. This file then links to CONTRIBUTING.md, which also shows up linked on the new issue or new pull request creation pages. For instance, on the right-hand-side, at the bottom, you should see:
In addition to these sources, we also have information spread out across the wiki. For instance, here and here.
Motivation and Context
At the very least, we need to make sure all these sources of information stay in sync. From what I've seen of other open source software projects, everything a potential user should need to know should show up in the README.md or CONTRIBUTING.md file. If either of those gets too lengthy and it seems prudent to break the information up over the wiki, everything should still be linked back into those files.