Update documentation #91
Conversation
|
@jeanbez, the width of the content on the pages seems to be fixed, and looks a bit narrow to me as it only covers the left half of the window if I view it full screen. Is this intended? |
|
@houjun, that is the default width for most readthedocs templates, but I believe we could increase it as needed. I would not recommend making it fully wide as it might look strange. Maybe we can double the current width? |
|
There are some code blocks that are just a bit too long for the current width, I'm debating whether to do more line breaks or increase the content width by something like 20%. What do you think? |
|
Hmm, got it. I personally prefer to have commands broken into multiple lines; it improves readability. But I can give it a try by increasing it by 20% to see if that improves. |
|
@houjun, can you give it another try now? If you do not see any changes, please force refresh the page to refresh the CSS. I believe it looks better now, but there are still some commands that would benefit from being split into multiple lines. |
|
Yes, once we merge the other pull request (which I added line breaks) to this branch then everything should fit within the page width. |
* Update README.md * Update getting_started.rst * Update getting_started.rst
Update documentation with both code and design.
Preview available at https://pdc.readthedocs.io/en/code-docs