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

DOC: fix a few dead links in docs, small changes to make 1st time dev instructions bit more clear #345

Merged
merged 4 commits into from
Sep 25, 2024

Conversation

nstelter-slac
Copy link
Contributor

@nstelter-slac nstelter-slac commented Aug 26, 2024

Description

Improve some minor things i noticed while reading the docs for 1st time: fix a few dead links in docs, link from readme to contributing doc so can't miss it, and explicitly list dev instructions

Motivation and Context

How Has This Been Tested?

Where Has This Been Documented?

Pre-merge checklist

  • Code works interactively
  • Code contains descriptive docstrings, including context and API
  • New/changed functions and methods are covered in the test suite where possible
  • Test suite passes locally
  • Test suite passes on GitHub Actions
  • Ran docs/pre-release-notes.sh and created a pre-release documentation page
  • Pre-release docs include context, functional descriptions, and contributors as appropriate

@nstelter-slac nstelter-slac changed the title Doc update DOC: fix a few dead links in docs, link from readme to contributing doc so can't miss it, and explicitly list dev instructions Aug 26, 2024
@nstelter-slac nstelter-slac changed the title DOC: fix a few dead links in docs, link from readme to contributing doc so can't miss it, and explicitly list dev instructions DOC: fix a few dead links in docs, small changes to make 1st time dev instructions bit more clear Aug 26, 2024
@nstelter-slac nstelter-slac marked this pull request as ready for review September 24, 2024 03:08
docs/source/containers.rst Outdated Show resolved Hide resolved
ZLLentz
ZLLentz previously approved these changes Sep 24, 2024
Copy link
Member

@ZLLentz ZLLentz left a comment

Choose a reason for hiding this comment

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

Good fixes/additions!

tangkong
tangkong previously approved these changes Sep 24, 2024
Copy link
Contributor

@tangkong tangkong 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 to me too! Thanks for the updates!

@nstelter-slac nstelter-slac dismissed stale reviews from tangkong and ZLLentz via 7ea8fa8 September 25, 2024 19:08
@ZLLentz ZLLentz merged commit d220161 into pcdshub:master Sep 25, 2024
11 checks passed
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