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 updates (CONTIBUTING.md link, redirector, and local build guidance) #133

Merged
merged 4 commits into from
Nov 12, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Nov 12, 2024

Description

This PR fixes the CONTRIBUTING.md link so it properly links to always-available documentation, adds to the redirector in case the main branch is not readable (when there are no additional commits beyond the current release tag), and adds local build guidance. Normally these could each be a separate PR but they were tiny and felt cohesive in the sense that they all pertain to docs.

Thanks for any feedback!

Closes #107
Closes #97
Closes #92

What kind of change(s) are included?

  • Documentation (changes docs or other related content)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • These changes pass all pre-commit checks.
  • I have added comments to my code to help provide understanding
  • I have added a test which covers the code changes found within this PR
  • I have deleted all non-relevant text in this pull request template.

@d33bs d33bs marked this pull request as ready for review November 12, 2024 14:57
Copy link
Member

@jenna-tomkinson jenna-tomkinson left a comment

Choose a reason for hiding this comment

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

LGTM! 🎉

docs/redirector.html Show resolved Hide resolved
@d33bs
Copy link
Member Author

d33bs commented Nov 12, 2024

Thanks @jenna-tomkinson ! Merging this in now.

@d33bs d33bs merged commit d7ef324 into WayScience:main Nov 12, 2024
9 checks passed
@d33bs d33bs deleted the docs-build-help branch November 12, 2024 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants