Add registry (#751)

This commit is contained in:
Simón Fishman 2023-10-02 12:51:36 -07:00 committed by GitHub
parent a5f727b98c
commit a9ca35c12d
4 changed files with 1050 additions and 2 deletions

View File

@ -33,4 +33,6 @@ Why are these changes necessary? How do they improve the cookbook?
- Styling and formatting align with existing documentation.
- Consistent use of punctuation and case.
When contributing a new example, make sure to add a new entry for it in [registry.yaml](/registry.yaml) to render it on the cookbook website.
**Note:** For additional guidelines on writing good documentation, check out [What Makes Documentation Good](https://cookbook.openai.com/what_makes_documentation_good).

View File

@ -15,10 +15,11 @@ Most code examples are written in Python, though the concepts can be applied in
For other useful tools, guides and courses, check out these [related resources from around the web](https://cookbook.openai.com/related_resources).
## Contributing
The contents of this repo are automatically rendered into [cookbook.openai.com](https://cookbook.openai.com). If there are examples or guides you'd like to see, feel free to suggest them on the [issues page](https://github.com/openai/openai-cookbook/issues). We are also happy to accept high quality pull requests, as long as they fit the scope of the cookbook.
If there are examples or guides you'd like to see, feel free to suggest them on the [issues page](https://github.com/openai/openai-cookbook/issues). We are also happy to accept high quality pull requests, as long as they fit the scope of the cookbook.
The contents of this repo are automatically rendered into [cookbook.openai.com](https://cookbook.openai.com) based on [registry.yaml](/registry.yaml). When contributing a new example, make sure to add a new entry for it in [registry.yaml](/registry.yaml) so that it renders on the website.
Refer to our guide on [what makes documentation good](https://cookbook.openai.com/what_makes_documentation_good) for guidance on how to make high quality contributions.

1012
registry.yaml Normal file

File diff suppressed because it is too large Load Diff

33
registry_schema.json Normal file
View File

@ -0,0 +1,33 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"path": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"authors": {
"type": "array",
"items": {
"type": "string"
}
},
"date": {
"type": "string",
"format": "date"
}
},
"required": ["title", "path", "tags", "authors"],
"additionalProperties": false
}
}