Major update to the existing documentation #341
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
And bug fixes when warnings are treated as failures
rafmudaf
requested review from
sayerhs,
ebranlard,
michaelasprague,
andrew-platt,
jjonkman and
ashesh2512
ebranlard
approved these changes
Oct 1, 2019
# Conflicts: # .travis.yml # docs/source/dev/index.rst # docs/source/install/install_cmake_windows.rst
|
@andrew-platt @ashesh2512 Could you take a look at the changes here and provide some feedback? |
rafmudaf
force-pushed
the
docs/general_updates
branch
from
45b6a28 to
fa52157
Compare
rafmudaf
force-pushed
the
docs/general_updates
branch
from
fa52157 to
b469487
Compare
|
Hearing no objections, I'm going to merge this pull request today. |
|
@rafmudaf , I haven't had time to read much of this and probably won't have time any time soon. I don't have any objections to you merging it. |
|
I have no objections to merging it. There are a few items related to BeamDyn that need updating. I will include those in the BeamDyn PR. |
andrew-platt
approved these changes
Nov 6, 2019
|
Ok, sounds good. This pull request does not change the user documentation, but I have some other ones coming regarding that portion of the docs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Complete this sentence
THIS PULL REQUEST IS READY TO MERGE.
Feature or improvement description
This pull request provides a major update to the online documentation in the form of general tidying and cleanup plus some restructuring of the layout and organization. All sections were modified except the user guide which will be updated in a subsequent pull request.
Installation
Testing
This is all structurally the same, but the content has been cleaned up and improved. Better examples for running the regression test are given.
Developer Guide
Sections yet to be improved:
Related issue, if one exists
None
Impacted areas of the software
Documentation
Test results, if applicable
A live version of these updates is available at: https://raf-openfast.readthedocs.io/en/docs-general_updates/