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

Updates to docs and README.rst #46

Merged
merged 21 commits into from
Nov 3, 2023
Merged

Updates to docs and README.rst #46

merged 21 commits into from
Nov 3, 2023

Conversation

pearce8
Copy link
Collaborator

@pearce8 pearce8 commented Nov 1, 2023

No description provided.

@slabasan
Copy link
Collaborator

slabasan commented Nov 2, 2023

@pearce8 The docs renders a little odd now with the URL in the title, can we move it to a sentence in the section? Something like:
You can find detailed documentation in [ReadtheDocs](https://software.llnl.gov/benchpark).

Rendered page here:
Screenshot 2023-11-01 at 9 18 31 PM

bin/benchpark Outdated Show resolved Hide resolved
@pearce8 pearce8 marked this pull request as ready for review November 2, 2023 21:45
@pearce8 pearce8 requested a review from slabasan November 2, 2023 21:45
@pearce8 pearce8 requested a review from scheibelp November 2, 2023 21:51
Copy link
Collaborator

@scheibelp scheibelp left a comment

Choose a reason for hiding this comment

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

I have one suggestion about referencing the FAQ somewhere, but this looks good (could merge without that change)

bin/benchpark Show resolved Hide resolved
docs/5-build-experiment.rst Outdated Show resolved Hide resolved
@pearce8 pearce8 merged commit f9e2ce2 into develop Nov 3, 2023
3 checks passed
@pearce8 pearce8 deleted the pearce8-patch-1 branch November 3, 2023 01:24
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