ReactionMechanismGenerator / RMG-Py

Python version of the amazing Reaction Mechanism Generator (RMG).
http://reactionmechanismgenerator.github.io/RMG-Py/
Other
400 stars 228 forks source link

Centralize documentation for developers #2736

Open jonwzheng opened 5 days ago

jonwzheng commented 5 days ago

Motivation

In #2703, we are moving information from the (difficult-to-maintain, outdated, and generally out-of-the-way) Wiki page to the main documentation + other parts of Github that receive more visibility.

This includes:

Issue

However, there isn't really a home for dev-specific information. Specifically, information like:

Solution

Ideally we have something that's just out of the way from the users so they don't get confused, but also not tucked away so much that it gets forgotten. And there's always the mental load of having to think of yet another platform for information.

We could even actually just use the Wiki but keep it to just like 1-3 pages so it's more manageable.

I welcome anyone's thoughts on this!