Skip to content

Commit

Permalink
📝 update todos
Browse files Browse the repository at this point in the history
  • Loading branch information
shroominic committed Jan 27, 2024
1 parent a5b7014 commit 60edca6
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
35 changes: 35 additions & 0 deletions docs/todo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# TODOs for writing the documentation

- [ ] convert MODELS.md into a seperate docs page

- [ ] explaination for important examples

- [ ] features breakdown

- [ ] list all different output types/parsers

- [ ] list all different input argument types

- [ ] section about prompt writing and jinja syntax + examples how prompts are compiled

- [ ] langchain compatibility explanation and examples

- [ ] async/await explanation and examples

- [ ] explaination of codebase structure and how to contribute

- [ ] bounties/todos for contributors

- [ ] union types/ error handling

- [ ] page about local models (llamacpp/ollama)

- [ ] document vision support

- [ ] how to scale/structure a complex codebase using funcchain

- [ ] funcchain settings

- [ ] streaming support and examples

- [ ] explain signature schema
6 changes: 3 additions & 3 deletions roadmap.todo
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
IMPORTANT:
IMPORTANT NOW:
[ ] - enable union type without function calling (6h)
[ ] - improve docs (8h)

COMING SOON:
TODO:

[ ] - pydantic model streaming (6h)

Expand Down Expand Up @@ -33,4 +33,4 @@ COMING SOON:

[ ] - FuncUnion and str output (6h)

[ ] - think of new syntax for special dspy modules (COT, FewShot, ...)
[ ] - think of new syntax for special dspy modules (COT, FewShot, ...)

0 comments on commit 60edca6

Please sign in to comment.