Restructure README: split into compact README + docs/ folder#38
Merged
Conversation
Move detailed documentation sections into separate files under docs/: - docs/api-reference.md: Constructor, methods, properties, data formats - docs/cli.md: Command line usage and device analysis - docs/examples.md: Basic and advanced usage examples - docs/mock-client.md: Mock client system for testing - docs/ssl.md: SSL/HTTPS configuration and migration - docs/security.md: Data classification and sensitive data - docs/type-hints.md: PEP-561 compliance and HA integration README.md reduced from ~980 to ~90 lines with quick start, CLI summary, supported devices table, and links to detailed docs.
ronaldvdmeer
force-pushed
the
docs/restructure-readme
branch
from
e91ab99 to
2890e01
Compare
PyPI version, Python version, license, Pylint, Mypy, and Tests badges.
Incorporates all fixes from docs/fix-readme-inaccuracies branch: - MockPooldoseClient examples: add required model_id and fw_code - API Reference: add missing constructor params and methods - CLI docs: add --version, mutual exclusivity note, --analyze requires --host - Device support: fix VA DOS EXACT alias reference - Mock client: translate German comment to English - README: fix alias table, remove changelog summary per maintainer request
Owner
|
All aligned in #37 |
Owner
|
I like, thanks for the badges as well. I think we can call this release 0.9.0 and go for publication. |
Contributor
Author
Feel free to publish the new release. It looks like we’ve reached a stable point, and the software should now be ready to support more similar devices. |
Owner
|
I can not edit the change log on my mobile, that's blocking me ;-) |
Owner
|
May I try to let copilot do the work |
Contributor
Author
|
One sec. i'm trying as well |
Merged
Contributor
Author
|
See: #39 |
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
2 participants
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.
Restructure README: split into compact README + docs/ folder
The README has grown to ~980 lines, making it hard to navigate. This PR splits the detailed documentation into a
docs/folder while keeping the README compact and focused.Changes
README.md reduced from ~980 to ~90 lines, now containing:
Detailed content moved to
docs/:docs/api-reference.mddocs/cli.mddocs/examples.mddocs/mock-client.mddocs/ssl.mddocs/security.mddocs/type-hints.mdWhy
docs/folderNo content was removed — everything was moved as-is.