-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Science section re-org #146
Comments
I meant to comment on this in the previous PR, but one aspect of this that I would like to improve is that with this anticipated layout, it takes a lot of navigation to get from the homepage to the documentation for a specific phase model. That is, you have: Cantera.org -> Science -> Thermodynamics -> (scroll down) Phases -> Specific Model There are two options of shortening this by one level that I can think of:
I think this second option might be better since it still leaves keeps "Phases" and "Species" pages available that can be used to explain some of the concepts that are general across multiple phase / species models. |
Thanks, @speth - this is a great point. I'll keep it in mind to see if there are placed to flatten the page structure a bit. In some cases, I think I can use cards at the top as links to a specific section, but keep the info on the same page so that a user can also just scroll down, if they already know where to look. (side note: not sure how this ended up in |
With the recent website reorganization (in particular Cantera/cantera#1647), I'd argue this is effectively complete. If there additional thoughts on how to better organize the "Science" docs, I think it would make sense to describe that in a new enhancement proposal. There is, of course, still plenty of room for expanding on the content of the science documentation, but I think that's covered by some of the other enhancement proposals. |
Abstract
I'd like to document my thoughts for next steps in reorganizing the website's
Science
section.Transport
landing page. My sense is that we can cover what we need to on a single page, without going into separatephase
andspecies
pages like we do for thermo, and without adding any other structure (e.g. cards), but we'll see, once it is in place.phase-thermo
,species-thermo
, andkinetics
pages with a bit more structure so that visitors to the website can more easily navigate to find what they want. My current plan is to use cards.Once item 2 is in place, resolving issues such as Add information on derivative calculation to science section cantera-website#169, Electrochemical Reactions missing from Science Section cantera-website#172, or New section for Equation of state documentation in the Science section cantera-website#174 should be pretty straightforward.
A brief description of the work being done.
Motivation
Describe the need for the work being done:
Description
References
The just merged Cantera/cantera-website#179 is the first step in this process.
The text was updated successfully, but these errors were encountered: