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

Documentation update #282

Merged
merged 66 commits into from
May 10, 2024
Merged

Documentation update #282

merged 66 commits into from
May 10, 2024

Conversation

dkazanc
Copy link
Collaborator

@dkazanc dkazanc commented Apr 16, 2024

Checklist of things to complete the documentation update:

@dkazanc
Copy link
Collaborator Author

dkazanc commented Apr 18, 2024

Completed Process Lists Guide. @yousefmoazzam could you please have a look, especially the side output part. If anything does not feel right, grammar or technical. thanks

@dkazanc
Copy link
Collaborator Author

dkazanc commented May 7, 2024

@yousefmoazzam I've added a section on how to Interpret Log File. However, as for our discussion block/s VS s/block we probably need to modify it slightly when it becomes clearer?

@yousefmoazzam
Copy link
Collaborator

@dkazanc Nice, thanks for the explanations of the logfile contents, that's going to be quite useful to reference to people when the release comes!

Agreed, once we figure out the meaning/reason behind seeing block/s or s/block we should update that section accordingly.

@dkazanc dkazanc marked this pull request as ready for review May 9, 2024 10:13
Copy link
Collaborator

@yousefmoazzam yousefmoazzam left a comment

Choose a reason for hiding this comment

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

Overall it's looking good to me, I've made a few comments regarding small typos and minor notes on wording in places.

There are sections where I think the wording of larger groups of text could be improved, but that's a bigger job that can be done later, I think this is a decent first pass at getting the bulk of the information in place 🙂

docs/source/developers/memory_calculation.rst Outdated Show resolved Hide resolved
docs/source/developers/memory_calculation.rst Outdated Show resolved Hide resolved
docs/source/explanation/templates.rst Outdated Show resolved Hide resolved
docs/source/howto/interpret_logger.rst Outdated Show resolved Hide resolved
docs/source/introduction/indepth/detailed_about.rst Outdated Show resolved Hide resolved
docs/source/introduction/indepth/wrappers.rst Outdated Show resolved Hide resolved
@dkazanc dkazanc merged commit aa21c1f into gpuloop May 10, 2024
@dkazanc dkazanc deleted the docs_update branch May 10, 2024 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants