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 updates #1062

Merged
merged 3 commits into from
Oct 17, 2024
Merged

doc updates #1062

merged 3 commits into from
Oct 17, 2024

Conversation

asonnenschein
Copy link
Contributor

@asonnenschein asonnenschein commented Oct 3, 2024

This MR includes updates to several different parts of the documentation:

  • Updated the Installation/Quick Start README docs to include installation instructions from PyPI, and some links to docs about configuring virtual environments in Python. Also updated the section on versions and stability in the README.
  • Added clearer link to CONTRIBUTING.md from README.md.
  • Updated CONTRIBUTING.md to align with changes to branch naming conventions described in Simplify Release Process #1061.
  • Updated Subscriptions CLI documentation to point to official Subscriptions API statuses documentation (Subscription status list in CLI docs is missing values #1001).

@asonnenschein
Copy link
Contributor Author

Update - I also went ahead and updated setup.py to reflect organizational changes.

Copy link
Contributor

@tbarsballe tbarsballe 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

@asonnenschein asonnenschein merged commit 5491c76 into main Oct 17, 2024
10 checks passed
@asonnenschein asonnenschein deleted the update-docs branch October 17, 2024 16: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.

2 participants