add descriptions for readme config fields in generators.yml reference #204
Conversation
|
✅ No documentation updates required. |
| @@ -402,30 +402,39 @@ readme: | |||
| ``` | |||
|
|
|||
| <ParamField path="readme" type="ReadmeSchema" required={false} toc={true}> | |||
| Configuration for customizing the generated README files. | |||
| </ParamField> | |||
|
|
|||
| <ParamField path="readme.bannerLink" type="string" required={false} toc={true}> | |||
There was a problem hiding this comment.
For all of these, could you take out the "readme."? It's a bit more user friendly. (Context: I'm the one who structured it this way in the first place😬, but I'm slowly going through and trying to improve this page section by section.)
example: path="readme.bannerLink" --> path="bannerLink"
| </ParamField> | ||
|
|
||
| <ParamField path="readme.apiReferenceLink" type="string" required={false} toc={true}> | ||
| URL to your external API documentation or reference guide. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="readme.defaultEndpoint" type="ReadmeEndpointSchema" required={false} toc={true}> |
There was a problem hiding this comment.
I think you can make defaultEndpoint a new subsection
### defaultEndpoint
Specifies which endpoint's code snippet to showcase as the primary example in the README.
<ParamField path="method" type="string" required={true} toc={true}>
HTTP method of the default endpoint (e.g., `GET`, `POST`, `PUT`, `DELETE`).
</ParamField>
etc
Context: I'm trying to do something similar in this outstanding PR: #175
| @@ -402,30 +402,39 @@ readme: | |||
| ``` | |||
|
|
|||
| <ParamField path="readme" type="ReadmeSchema" required={false} toc={true}> | |||
There was a problem hiding this comment.
Since readme is the top-level option, I think you can actually remove the ParamField formatting and move the description up above the yaml code block. (Might need to do some wordsmithing to merge it with the existing description.)
| </ParamField> | ||
|
|
||
| <ParamField path="readme.defaultEndpoint.stream" type="boolean" required={false} toc={true}> | ||
| Whether the endpoint is a streaming endpoint. Defaults to `false`. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="readme.features" type="map<string, list<ReadmeEndpointSchema>>" required={false} toc={true}> |
There was a problem hiding this comment.
If you have the time, I think it would be great to have features as another subsection and then separate ParamFields for each feature name ie authentication, users, and their subfields.
There was a problem hiding this comment.
Also feel free to skip this, definitely ok to merge your changes without adding this info!
There was a problem hiding this comment.
Sounds good I will pick up this as an item for later then!
Co-authored-by: Devin Logan <[email protected]>
We had some questions about readme generation so updating these values so customers know what each field is.