docs: refresh README and fix package metadata - #37
Merged
Merged
Conversation
Replace OpenAPI boilerplate in README with install, auth, and usage sections; point API reference to docs/. Fix placeholder repository URL and keywords in pyproject.toml and setup.py. Remove unused git_push.sh (generator helper; ignored on regen).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
access_token+ workspace header), a short usage example, and pointers todocs/for generated API reference.pyproject.toml(replacingGIT_USER_ID/GIT_REPO_ID) andsetup.pyurl; align description and keywords.git_push.sh(OpenAPI template script). The file remains listed in.openapi-generator-ignoreso client regeneration does not recreate it.