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

fix(docs): Move developer specific docs from README.md to CONTRIBUTING.md #122

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

dagardner-nv
Copy link

  • Move the section regarding the test examples to CONTRIBUTING.md, this information is developer specific and resulted in broken links on pypi.org
  • Remove the table of contents, as the anchor tags were similarly broken on pypi.org
  • Misc spelling error fix.

Closes #121

@jameslamb jameslamb self-requested a review January 6, 2025 19:34
@jameslamb jameslamb added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Jan 6, 2025
Copy link
Member

@jameslamb jameslamb left a comment

Choose a reason for hiding this comment

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

Thanks for this!

I support these changes to make the README a bit better-suited to also being the PyPI.org homepage for the project.

Just one more suggestion... there's one more anchor reference that'll be broken. I think this line can just be removed completely:

> The [Examples](#examples) section below has instructions on where example `dependency.yaml` files and their corresponding output can be viewed.

@dagardner-nv
Copy link
Author

Thanks for this!

I support these changes to make the README a bit better-suited to also being the PyPI.org homepage for the project.

Just one more suggestion... there's one more anchor reference that'll be broken. I think this line can just be removed completely:

> The [Examples](#examples) section below has instructions on where example `dependency.yaml` files and their corresponding output can be viewed.

Done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation non-breaking Introduces a non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Links on pypi.org are broken
2 participants