microsoft / microsoft/TypeChat
There's no Python specific documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 8.7k
- Forks
- 414
- Avg merge
- 3h 8m
- Merged PRs (30d)
- 3
Description
In the README.md of the python subtree there's this sentence:
To learn more about TypeChat, visit the documentation which includes more information on TypeChat and how to get started.
However, the docs found at that link are exclusively aimed at a TypeScript audience, and give no specifics about e.g. how to write a schema in Python. I had to glean that from the examples, which is far from ideal. I had hoped for something like a Python version of Basic TypeScript Usage.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with python/README.md and the linked TypeChat documentation, especially the TypeScript Basic Usage page and the Python examples. Add Python-specific guidance for getting started and writing a schema, with navigation from the Python README; done means Python users can follow the documentation without inferring usage from examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100