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

Make link to processing info doc more prominent #254

Merged
merged 4 commits into from
Nov 16, 2022

Conversation

cbethell
Copy link
Contributor

Issue Addressed
Closes #238

What is the purpose of these changes?

Per #238, the existence of the processing-information.md file is not obvious in the way we link to the documentation in the headers of the workflow steps. This PR tries to make linking to the processing info documentation more prominent.

What changes did you make?

This PR fixes the existing links to the processing-information.md file (now that we moved it into the subfolder additional-docs) and adds a couple additional mentions of the documentation itself in the effort to make its existence a bit more obvious to users.

Any comments, concerns, or questions important for reviewers

Checklist

Place an x in all boxes that you have completed.

  • I have run the most recent version of the code
  • If I am adding in reports or generating any plots, I have reviewed the necessary reports
  • I have added all necessary documentation (if applicable)

@cbethell cbethell requested a review from allyhawkins November 11, 2022 15:04
Copy link
Member

@allyhawkins allyhawkins left a comment

Choose a reason for hiding this comment

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

This generally looks good, just a comment on how to make the link even more obvious.

README.md Outdated Show resolved Hide resolved
@cbethell
Copy link
Contributor Author

I added that button as you suggested @allyhawkins, good call! Let me know what you think of things now 👍

@cbethell cbethell requested a review from allyhawkins November 15, 2022 18:52
Copy link
Member

@allyhawkins allyhawkins left a comment

Choose a reason for hiding this comment

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

Looks good, just one more suggestion, but I don't need to see it again.

README.md Show resolved Hide resolved
@cbethell cbethell merged commit bf8f7c3 into development Nov 16, 2022
@cbethell cbethell deleted the cbethell/emphasize-processing-doc-link branch November 16, 2022 16:28
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.

2 participants