Dev docs #6
Merged
Dev docs #6
Conversation
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
- Created initial documentation structure including index, features, and user guide in both English and Chinese. - Added examples for basic usage and advanced features such as Docker commands and HTTP requests. - Implemented interactive command-line application examples demonstrating the use of ptcmd's features. - Included rich text output and automatic command completion in examples. - Established a consistent application structure and installation instructions in the documentation.
- Add line numbers to code snippets in documentation - Update examples to use more descriptive variable names - Improve test and coverage commands in Makefile - Add mermaid2 plugin to mkdocs.yml for diagram support - Update CommandFunc type to include Coroutine - Modify do_shell method to use asyncio subprocess
- Remove outdated information about argument parsing - Add detailed explanation of help system - Update code examples and clarify command structure - Improve formatting and organization of the document
- Add `entrypoint` decorator to simplify CLI entry point creation - Update documentation to include new section - Add tests for `entrypoint` decorator functionality - Improve test coverage for argument parsing and command execution
- Update navigation structure in .nav.yml for better organization - Remove empty index files for examples - Add comprehensive content to index.md files - Create structure and content for user guide
Codecov Report❌ Patch coverage is
@@ Coverage Diff @@
## master #6 +/- ##
==========================================
+ Coverage 87.30% 87.39% +0.08%
==========================================
Files 7 7
Lines 780 801 +21
Branches 155 156 +1
==========================================
+ Hits 681 700 +19
- Misses 55 56 +1
- Partials 44 45 +1
🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.