feat: refactor docs and add content around tools and authoring #74
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
tylerslaton
requested review from
ibuildthecloud,
cloudnautique,
cjellick,
thedadams,
njhale and
g-linville
tylerslaton
force-pushed
the
tool-docs
branch
from
7c0542b to
798aa98
Compare
tylerslaton
force-pushed
the
tool-docs
branch
from
8e5f791 to
72c0b0e
Compare
njhale
approved these changes
Feb 26, 2024
There was a problem hiding this comment.
Looks good.
Could you also update the copyright year in the README.md?
https://github.com/gptscript-ai/gptscript?tab=readme-ov-file#license
it still reads 2023
g-linville
requested changes
Feb 26, 2024
tylerslaton
force-pushed
the
tool-docs
branch
2 times, most recently
from
274b742 to
af0d2a3
Compare
g-linville
approved these changes
Feb 26, 2024
|
|
||
| ```yaml | ||
| description: This is a tool that calls a shell script. | ||
| args: arg1: The first argument. |
There was a problem hiding this comment.
Should we use the first argument? Its not clear if it is being used or not to the reader.
There was a problem hiding this comment.
I believe that this is addressed everywhere now!
cloudnautique
approved these changes
Feb 27, 2024
tylerslaton
force-pushed
the
tool-docs
branch
5 times, most recently
from
669c121 to
247f28e
Compare
- chore: add note about adding local model support - docs: add image-generator cookbook - docs: add gen-docs.gpt and a make target for it Signed-off-by: tylerslaton <[email protected]>
tylerslaton
force-pushed
the
tool-docs
branch
from
6b81dde to
b1db1e2
Compare
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.
First pass at some documentation around what tools are, how they work, and how you can make them. This also include some restructuring to make content flow more naturally.
To test this out, run
make serve-docs.At the time of creating this PR, the packaging format for external tools (as we want it to look) has not been implemented. This PR reflects the current state of things.