Document CLI and library usage - #456
Open
Drew-Chase wants to merge 5 commits into
Open
Drew-Chase wants to merge 5 commits into
Drew-Chase wants to merge 5 commits into
Conversation
Owner
|
Thanks for taking the time to write these docs. I am not oppose to this idea by itself. However, free unbound markdown files risk stale. I rather you add them to the source code. If you still need markdown files for some reason, then you may write a subprogram (as a Ideally, all the code and the identifiers are checked by either the compiler or the tests. The more constrains can be encoded and tracked by automation, the better. |
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
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.
I originally wrote this as a git submodule for the wiki, until I realized that you couldn't create a pull request for the wiki repo, so I've put it in the docs directory as a compromise.
pduCLI usage.Notes
This PR focuses on improving user-facing and contributor-facing documentation. It makes the CLI and library APIs easier to discover, explains common workflows, and consolidates the wiki documentation without keeping the wiki as a Git submodule.
Note
The docs were written by a human and checked by AI