{{ message }}
[WIP] Add documentation#59
Closed
suargi wants to merge 20 commits into
Closed
Conversation
Sorry, something went wrong.
Add personal documentation and documentation from pull requests and the template config file
pcarruscag
reviewed
Aug 26, 2021
pcarruscag
left a comment
pcarruscag
left a comment
Member
There was a problem hiding this comment.
Awesome! Thank you for adding these much-needed pages on gradients/limiters and turbulence models.
I have still have to finish reading the turbulence part, but here are some suggestions:
Sorry, something went wrong.
8 hidden conversations
Load more…
Co-authored-by: Pedro Gomes <38071223+pcarruscag@users.noreply.github.com>
Co-authored-by: Pedro Gomes <38071223+pcarruscag@users.noreply.github.com>
Co-authored-by: Pedro Gomes <38071223+pcarruscag@users.noreply.github.com>
…/suargi/su2code.github.io into feature_additional_documentation
Co-authored-by: Pedro Gomes <38071223+pcarruscag@users.noreply.github.com>
Co-authored-by: Pedro Gomes <38071223+pcarruscag@users.noreply.github.com>
Co-authored-by: Pedro Gomes <38071223+pcarruscag@users.noreply.github.com>
Co-authored-by: Pedro Gomes <38071223+pcarruscag@users.noreply.github.com>
Co-authored-by: Pedro Gomes <38071223+pcarruscag@users.noreply.github.com>
…/suargi/su2code.github.io into feature_additional_documentation
Author
|
This PR is quite old and I do not remember exactly what is its status. I will create additional but smaller pull request, e.g., #81 in order to include all the updated document ion from this PR. At the end, this PR will be useless and can be closed. |
Sorry, something went wrong.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.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.
Add documentation from my personal notes, pull requests and the template config file into SU2 website.
I have been taking notes on how to use SU2 and important features that I think are missing in the documentation. I would like to contribute to the documentation. Besides, in my opinion the template config file and pull requests are not a source for documentation, although the config file can support the documentation. So, I gathered major point from them and included into the website documentation.
It is a little bit difficult to link the website content and the two references in https://github.com/su2code/Documentation/tree/master/Articles as they have "different" content and the papers are somehow outdated.
There are certain aspects that I am not sure and would be nice if you could double check. I have marked them with a "?" for further discussion.
Sorry for grammar errors :)