Conversation
|
It should pay extra attention to balance between making it easy to read for beginners and making it comprehensive to look up for experienced users. The old manual is only designed for experienced users so it may need extra editing to tailor it. Here is just a draft about how to move and re-organize the previous content in the old manual. TOC of the old manual TOC of the new manual Previous version of the new manual had only |
|
New manual Old manual |
|
@sbillinge It's ready for review. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #276 +/- ##
=======================================
Coverage 95.10% 95.10%
=======================================
Files 23 23
Lines 1123 1123
=======================================
Hits 1068 1068
Misses 55 55 🚀 New features to boost your workflow:
|
doc/source/extras.rst
Outdated
| ============================================ =============================== | ||
| AtomEyeAtomEye structure viewer, XCFG format http://li.mit.edu/A/Graphics/A/ | ||
| ============================================ =============================== | ||
| PyMOLPyMOL structure viewer, PDB format https://www.pymol.org |
There was a problem hiding this comment.
I think the preferred one these days is VESTA. Would it be possible for you to test using VESTA in this role and then adding that (and possibly removing atomeye and pymol, or at least determinging if they are still maintained packages? Leave them if htey are, but put VEST top.
update. I took a quick look and it seems that atomeye is not supported. I suggest we drop mention of atomeye, put vesta top but leave pymol (which is still supported...it is owned by schrodinger now)
There was a problem hiding this comment.
I tried VESTA. It works
news/rm_texinfo.rst
Outdated
|
|
||
| **Removed:** | ||
|
|
||
| * <news item> |
There was a problem hiding this comment.
we need to mention the manual is removed
news/rm_texinfo.rst
Outdated
| @@ -0,0 +1,23 @@ | |||
| **Added:** | |||
|
|
|||
| * <news item> | |||
There was a problem hiding this comment.
mention tutorial info from the old manual is added to the online docs
doc/source/tutorial.rst
Outdated
| PDFgui layout | ||
| ============= | ||
|
|
||
| First, Open ``pdfgui``. Instructions for doing this depend on your system, but an example would be to open a terminal, activate your pdfgui conda environment, and type ``pdfgui`` at the prompt, or to double-click a project file on windows. |
|
@sbillinge It's ready for review. |
2 participants
close #274