Draft
Conversation
Contributor
|
Looks good so far. I think this could work well, where the most basic usage is covered in the readme and the more expanded usage (especially the CLI) is in the document MD file. A few links to the documentation need adjusting (link doesn't exist). I think the documentation developer page can be deleted entirely. If anyone is developing for CLI they can refer to the documentation repo which contains the same info and more. The strips libs instructions could be moved from the readme to the dedicated documentation file. |
Contributor
Author
|
Yea, the links don't exist right now, but will fix them. I'll slowly make the new documents.md file with your updates |
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.
This is a work in progress! We don't push this until after the GUI update pretty much.
The entire docs/ folder will be only have images folder and the new single documentation.md file.
How does this look so far? What other changes should we make to this file?