mirror of
https://github.com/james-m-jordan/openai-cookbook.git
synced 2025-05-09 19:32:38 +00:00
Reorganize contribution materials (#783)
This commit is contained in:
parent
fc8411231f
commit
ee86d5febb
@ -1,4 +1,4 @@
|
|||||||
# Rubric
|
# Welcome, AI Chef
|
||||||
|
|
||||||
The OpenAI Cookbook is a community-driven resource aimed at sharing knowledge in a way that is accessible, engaging, and enriching for everyone. To ensure the quality of submissions, we have established a rubric that assesses each contribution on various areas.
|
The OpenAI Cookbook is a community-driven resource aimed at sharing knowledge in a way that is accessible, engaging, and enriching for everyone. To ensure the quality of submissions, we have established a rubric that assesses each contribution on various areas.
|
||||||
|
|
||||||
@ -8,7 +8,7 @@ We encourage contributors to familiarize themselves with this rubric before writ
|
|||||||
|
|
||||||
For additional guidelines on writing good documentation, refer to [What Makes Documentation Good](https://cookbook.openai.com/what_makes_documentation_good).
|
For additional guidelines on writing good documentation, refer to [What Makes Documentation Good](https://cookbook.openai.com/what_makes_documentation_good).
|
||||||
|
|
||||||
## Template
|
## Rubric
|
||||||
|
|
||||||
| Criteria | Score |
|
| Criteria | Score |
|
||||||
| ----------------------------- | ----- |
|
| ----------------------------- | ----- |
|
||||||
@ -20,7 +20,7 @@ For additional guidelines on writing good documentation, refer to [What Makes Do
|
|||||||
| Usability | |
|
| Usability | |
|
||||||
| Completeness | |
|
| Completeness | |
|
||||||
|
|
||||||
## Breakdown
|
### Breakdown
|
||||||
|
|
||||||
#### Relevance
|
#### Relevance
|
||||||
|
|
@ -1,4 +1,4 @@
|
|||||||
# yaml-language-server: $schema=./admin/registry_schema.json
|
# yaml-language-server: $schema=./.github/registry_schema.json
|
||||||
|
|
||||||
# This file is used to generate cookbook.openai.com. It specifies which paths we
|
# This file is used to generate cookbook.openai.com. It specifies which paths we
|
||||||
# should build pages for, and indicates metadata such as tags, creation date and
|
# should build pages for, and indicates metadata such as tags, creation date and
|
||||||
|
Loading…
x
Reference in New Issue
Block a user