Skip to content

Restructure docs to use README as long desc #106

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

Merged
merged 1 commit into from
May 10, 2024

Conversation

thc202
Copy link
Member

@thc202 thc202 commented May 9, 2024

Move contributing guidelines to its own file to have the README just for usage information and be more suitable as long description of the project (show in PyPI website).
Also, include Custom Payloads in the API client, missed in previous change.


Release failed because of missing long desc:

ERROR long_description has syntax errors in markup and would not be rendered on PyPI.
No content rendered from RST source.

https://github.com/zaproxy/zap-api-python/actions/runs/9021271433/job/24788221368#step:6:20

Move contributing guidelines to its own file to have the README just
for usage information and be more suitable as long description of the
project (show in PyPI website).
Also, include Custom Payloads in the API client, missed in previous
change.

Signed-off-by: thc202 <[email protected]>
Copy link
Member

@ricekot ricekot left a comment

Choose a reason for hiding this comment

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

Thanks!

@ricekot ricekot merged commit 61dc5ff into zaproxy:main May 10, 2024
7 checks passed
@thc202 thc202 deleted the add-long-desc branch May 10, 2024 06:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants