search

sandialabs / NuMAD

Numerical Manufacturing And Design Tool (NuMAD) -- A design tool for wind and water turbine composite blades
http://numad.readthedocs.io/
Other
33 stars 19 forks source link

Doc updates #1

Closed kmruehl closed 3 years ago

kmruehl commented 3 years ago

Draft PR for doc updates

kmruehl commented 3 years ago

@ecamare this PR is in progress, but you can review the revisions thus far.

Here's an overview of what I've done thus far:

This will be included in a separate PR:

kmruehl commented 3 years ago

@ecamare this PR should be ready for review

ecamare commented 3 years ago

Hi Kelley, great work. Thank you. I like the split of main.rst into separate files. Question, I have another PR with Evan where there have been changes to the main.rst. I'm not sure if I should merge your PR into the main branch first or the other one. Do you know which would be better. It sound like either way, I'll need to do many manual operations.

kmruehl commented 3 years ago

@ecamare either way. GitHub makes it relatively easy to resolve conflicts with text files, so the order doesn't matter too much. Since this PR is ready for a merge, I would recommend going ahead and merging it. Then we can work together to resolve the merge conflicts for the docs.

kmruehl commented 3 years ago

Since we've decided to keep the *.html in the docs directory (option 3 from the emails), I'm going to make one more commit that adds the docs/_build directory back to the repo.

ecamare commented 3 years ago

sound's good. I'll start merging this branch now.

kmruehl commented 3 years ago

@ecamare there are some unresolved merge conflicts here that need to be resolved, lmk if you'd like help.

kmruehl commented 3 years ago

@ecamare I've resolved the merge conflicts from #2, this PR should be ready to merge now.