-
Notifications
You must be signed in to change notification settings - Fork 5
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
Update docs #73
Update docs #73
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a nice update, but I think that information in the documentation shouldn't be duplicated in the readme.
README.md
Outdated
@@ -111,11 +111,10 @@ cmake -DCMAKE_CXX_COMPILER=g++ \ | |||
This way, all the functionalities are executed on A100 GPUs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's not the best idea to duplicate install instructions on both the readme and on the doc. This is an error-prone process (DRY). Since GitHub can display RST files, a different approach is possible.
You should have a condensed section on how to use KokkosFFT as a subdirectory dependency (this is likely how a programmer would start using this library), then have an anchor to the documentation where the complete install process is given:
Further installation details are provided in the [documentation](./docs/intro/building.rst).
I think this approach could be used for other sections of the readme. In other words, this file (which is the first contact for a potential user) would be a simple starter, redirecting to more complete documentation pages.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is indeed a duplicate if people read both README.md
and docs. However, people may not necessarily read the docs. Not sure what is the right way.
Close this PR, because of asyucrhouns commits issue. |
This PR aims at final updating of docs before release.
docs
updated based on recent changes