Skip to content
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

Include legacy documentation in pdf and MS Word format - Modules #866

Merged
merged 18 commits into from
Mar 25, 2022

Conversation

rafmudaf
Copy link
Collaborator

Feature or improvement description
Until the legacy documentation can be fully converted to the readthedocs / sphinx format, we will be including old documentation in the existing format.

This pull request includes documentation for specific modules and FAST.Farm. It is a follow on to #805.

Related issue, if one exists
#804

Impacted areas of the software
Online docs.

See the documentation live at https://raf-openfast.readthedocs.io/en/docs-legacy/source/user/index.html

@ebranlard
Copy link
Contributor

Sorry if this is already included, but it would be nice to add some links for the simulink interface. I think the main documentation is in the FAST 8 pdf document. But we can also point to how to compile it, and where the examples are in the repository. I did receive a bunch of questions about this lately. Sorry if it's already included. Here's the info I was provided with:

The FAST v8 User's Guide provides some documentation on the Simulink interface (https://www.nrel.gov/wind/nwtc/assets/downloads/FAST/FASTv8.16/README_FAST8.pdf).

The above FAST v8 guide can be used with the code and examples here:
https://github.com/OpenFAST/openfast/tree/dev/glue-codes/simulink

@rafmudaf
Copy link
Collaborator Author

Thanks for the suggestion @ebranlard. This pull request is related to a specific list of documentation Jason outlined earlier in the year. I've opened a new issue regarding the Simulink documentation: #868. Please continue to add context and ideas there.

Copy link
Collaborator

@jjonkman jjonkman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rafmudaf -- Thank you very much for making these improvements to the OpenFAST documentation. This should be a great help to the user and developer communities! Please find a few recommended changes below.

docs/source/user/index.rst Outdated Show resolved Hide resolved
docs/source/user/index.rst Outdated Show resolved Hide resolved
docs/source/user/index.rst Outdated Show resolved Hide resolved
docs/source/user/beamdyn/index.rst Outdated Show resolved Hide resolved
docs/source/user/servodyn/index.rst Show resolved Hide resolved
docs/source/user/hydrodyn/modeling_considerations.rst Outdated Show resolved Hide resolved
docs/source/user/hydrodyn/modeling_considerations.rst Outdated Show resolved Hide resolved
docs/source/user/hydrodyn/appendix.rst Outdated Show resolved Hide resolved
@rafmudaf rafmudaf added this to the v3.1.0 milestone Oct 25, 2021
@rafmudaf rafmudaf modified the milestones: v3.1.0, v3.2.0 Mar 2, 2022
@rafmudaf
Copy link
Collaborator Author

@jjonkman I've addressed your comments here and merged the latest dev branch

Copy link
Collaborator

@jjonkman jjonkman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing my comments from my original review. I now approve this merge. Please find one minor change below.

docs/source/user/beamdyn/index.rst Outdated Show resolved Hide resolved
@rafmudaf rafmudaf merged commit 032fd16 into OpenFAST:dev Mar 25, 2022
@rafmudaf rafmudaf deleted the docs/legacy branch March 25, 2022 13:58
@rafmudaf rafmudaf mentioned this pull request Jul 8, 2022
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants