docs: add beginner documentation (overview, quickstart, tutorial, glossary) - #238
Conversation
There was a problem hiding this comment.
This file is good to have, except that users will likely not need to know what all of the internals of the library do, especially at the start. All they interact with is the command line and the config.
Also, task_master is being deprecated and won't be handling orchestration anymore, just FYI.
| 2. Initialize the project (installs .ww dependencies): | ||
|
|
||
| ```bash | ||
| woodwork init |
There was a problem hiding this comment.
It is woodwork --init, and should be run after the config file is created as it reads the components there do determine what dependencies to install.
| # main.ww | ||
|
|
||
| my_agent = agent openai { | ||
| model = "gpt-4" |
There was a problem hiding this comment.
the config for a property is model: "gpt-4", not the equals sign here.
| model = "gpt-4" | ||
| } | ||
|
|
||
| input = input.cli {} |
There was a problem hiding this comment.
the input should probably be like this:
input = input command_line {
to: my_agent
}
|
|
||
| input = input.cli {} | ||
|
|
||
| pipeline = workflow { |
There was a problem hiding this comment.
don't include pipelines and workflows for now. Also, you should maybe make this example more simple, and just do an LLM instead of an agent.
There was a problem hiding this comment.
You'll also need to provide instructions for providing a .env file in the project root directory and referencing variables in that for your openai LLM setup
There was a problem hiding this comment.
I don't think this first project is a great example, it copies what is in the quickstart exactly. remove this file for now.
2 participants
This PR adds a small set of beginner-friendly documentation to help new contributors get started quickly:
These are intentionally short and focused so newcomers have a clear path from installation to a runnable example. Please review and merge if acceptable; I can follow up with additional short tutorials or format/lint fixes if desired.