CycloneDX / CycloneDX/cyclonedx-python-lib

[DOCS] showcases, examples & general docs improvements

Open
#396 5 comments 0 reactions 0 assignees View on GitHub
documentation help wanted
Dominant language
Python
Stars
116
Forks
67
Avg merge
8d 2h
Merged PRs (30d)
2

Description

:mega: THIS IS A CALL FOR DOCS
Feel free to add pull requests with examples here:
- https://github.com/CycloneDX/cyclonedx-python-lib/tree/main/examples
- https://github.com/CycloneDX/cyclonedx-python-lib/blob/main/docs/examples.rst

----

There are currently no (complex) examples how to use this lib.

Yes, there are API docs, and small snippets, but no examples.
Even the unit tests do now showcase example usage, as they are much declarative or not expressive enough.

GOAL:
- [x] have examples in a `examples` folder
- [x] link the examples in the README
- [x] link the examples in the (api)-docs
- [x] prevent `examples` dir from being shipped (sdist/bdist)
- [x] have examples run in CI

----

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing examples/ directory and docs/examples.rst, then check how they are linked from the README and API documentation. Because every listed goal is checked, first identify a remaining example or documentation gap; done means documenting a useful complex usage example and keeping the relevant links and CI expectations correct.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.