-
Notifications
You must be signed in to change notification settings - Fork 7
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
Restructure docs #1121
Comments
@RosalynLP Having read the relevant section I've decided to keep the section in "Get rid of documentation from code development resources" so I've ticked it off. If you have strong opinions contrary to this let me know! |
I wonder whether we want to merge the data/theory storage section with the theory section, so perhaps we should have a look at doing that later on |
May I suggest we change "Documentation contents" simply to "Contents"? |
Also, I would change "Code for data: validphys" to "Analysis code: validphys" or something similar, otherwise it could be confused with experimental data |
yes that's a good idea, I was struggling to think of a title so I thought we could always change it later but just having "validphys" and "buildmaster" etc. as headings is very confusing for a new user so thought we needed to clarify. I was deliberating before but the reason I didn't go with "analysis" code is because vp also does other stuff, e.g. server access, setupfit and things, but maybe overall it's better to call it analysis code as you say |
omg are we done? As far as overall summary is concerned I did a mini one with 3 bullet points but thought we could add more if needed... also we're going to have the code summary from mikey come in at some point which should help explain the structure. Do you think we need much else in the overall summary @voisey? |
Yes, I see the problem with my suggestion for validphys... I think the overall summary looks good for the moment, thanks! I think with this PR we should be aiming to get the overall structure in place and then we can tweak/add things in future with other PRs, so I think the current state of it is more than enough. What do you think? |
This is the plan @voisey and I made today for restructuring the docs. PR #1122.
Plan for layout - tick when summary done
General
Getting started
Tutorials
The text was updated successfully, but these errors were encountered: