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

Update docs #73

Closed
wants to merge 22 commits into from
Closed

Update docs #73

wants to merge 22 commits into from

Conversation

yasahi-hpc
Copy link
Collaborator

This PR aims at final updating of docs before release.

  1. files under docs updated based on recent changes
  2. README.md updated
  3. fix issues in Doxygen

@yasahi-hpc yasahi-hpc self-assigned this Feb 29, 2024
@yasahi-hpc yasahi-hpc added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 29, 2024
Copy link
Collaborator

@pzehner pzehner left a 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.
Copy link
Collaborator

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.

Copy link
Collaborator Author

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.

docs/intro/building.rst Outdated Show resolved Hide resolved
docs/intro/building.rst Outdated Show resolved Hide resolved
docs/intro/building.rst Outdated Show resolved Hide resolved
@yasahi-hpc yasahi-hpc requested a review from pzehner March 1, 2024 11:17
@yasahi-hpc
Copy link
Collaborator Author

Close this PR, because of asyucrhouns commits issue.

@yasahi-hpc yasahi-hpc closed this Mar 1, 2024
@yasahi-hpc yasahi-hpc mentioned this pull request Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants