-
-
Notifications
You must be signed in to change notification settings - Fork 12
docs: update documentation structure #548
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
docs: update documentation structure #548
Conversation
02c0aeb to
e6f824a
Compare
msclock
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have added some suggestions and hope they are helpful.
Co-authored-by: msclock <msclock@126.com> Signed-off-by: Xuan (Sean) Hu <i@huxuan.org>
All looks good! Thanks! Also a note that, some content may be outdated, I will refine them one by one later. This pull request mostly focus on the overall organization. |
|
Happy it helps, and I also noticed there is a CLI section. This inspires me to consider if it could be an optional feature for package development only. BTW this is a big change. |
I thought so, but I think it might be OK to have a default CLI that only show something like version. But actually I thought maybe I should use
Yeah, I tried to reduce the changes and most of the content are only reorganized. That is also the reason I leave some outdated information unchanged. |
Got it, thanks for the explanation. |
|
🎉 This PR is included in version 0.0.51 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
📚 Documentation preview 📚: https://ss-python--548.org.readthedocs.build/en/548/