-
Notifications
You must be signed in to change notification settings - Fork 88
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
Rhodium docs #184
Rhodium docs #184
Conversation
I think the content itself is good, but I'm a bit in doubt of it's location. It takes a lot of space on the main page, while it's partly background information. The main page should be about the bare essentials to get up to speed and started. On the other hand I don't see another obvious place for this information. |
I went back and forth on exactly this problem. The alternative I saw would be to add it as a separate entry under getting started. I decided to first write the content and make sure that was on point. The advantage of adding it under getting started is that it would be a placeholder for expanding the conversation to other libraries that are not in Python but are similar in scope, like the MORDM framework in R and OpenMOLE. |
Maybe a very short 2 line summary in getting started, and than this expanded text under Getting started |
also reorganizing docs into getting_started folder and update all related references to these docs
avoids including versions in getting started toc
and now properly fixed
I reorganized the comparison to rhodium into its own page. As part of this, I moved all getting started files to their own folder and modified the changelog file to avoid indexing beyond the main page. I think with some minor commit magic this is now ready to be merged |
Let me know if I can squash and merge this. I think it is ready and your review comments have been addressed. |
Yeah looks good, sorry for taking so long. The main thing I currently don't like is the Changelog being in two places, that means additional maintenance (at some point we're going to forget updating on or oneother. Could we link CHANGELOG.md to Read the Docs and remove the other? |
The setup should be that we only modify the changelog in the source code. Readthedocs parses this file to create the version within the docs directory. See the code below from conf.py. I want the changelog to be part of the source code that you install so that you can always check it even when not having internet access. EMAworkbench/docs/source/conf.py Lines 262 to 266 in 3f60527
|
I like the idea, but I have a few questions about it. Let's discuss it in person at our next meeting. |
closing #35