Skip to content

Conversation

@huxuan
Copy link
Member

@huxuan huxuan commented May 16, 2024


📚 Documentation preview 📚: https://ss-python--548.org.readthedocs.build/en/548/

@huxuan huxuan force-pushed the xuan.hu/overall-doc-refine branch from 02c0aeb to e6f824a Compare May 16, 2024 09:42
@huxuan huxuan changed the title doc: update documentation structure docs: update documentation structure May 16, 2024
@huxuan huxuan linked an issue May 16, 2024 that may be closed by this pull request
@huxuan huxuan marked this pull request as ready for review May 16, 2024 10:19
@huxuan huxuan requested a review from msclock May 16, 2024 10:19
@huxuan huxuan enabled auto-merge (squash) May 16, 2024 10:19
Copy link
Contributor

@msclock msclock left a 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.

huxuan and others added 2 commits May 17, 2024 09:20
Co-authored-by: msclock <msclock@126.com>
Signed-off-by: Xuan (Sean) Hu <i@huxuan.org>
@huxuan
Copy link
Member Author

huxuan commented May 17, 2024

I have added some suggestions and hope they are helpful.

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.

@msclock
Copy link
Contributor

msclock commented May 17, 2024

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.

@huxuan
Copy link
Member Author

huxuan commented May 17, 2024

I also noticed there is a CLI section. This inspires me to consider if it could be an optional feature for package development only.

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 click rather than typer as the default option.

BTW this is a big change.

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.

@huxuan huxuan requested a review from msclock May 17, 2024 01:52
@msclock
Copy link
Contributor

msclock commented May 17, 2024

That is also the reason I leave some outdated information unchanged.

Got it, thanks for the explanation.

@huxuan huxuan merged commit f1c7dec into serious-scaffold:main May 17, 2024
@huxuan huxuan deleted the xuan.hu/overall-doc-refine branch May 17, 2024 01:58
@serious-scaffold
Copy link
Contributor

🎉 This PR is included in version 0.0.51 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Overall refinement for the documentation.

2 participants