docs: add JSON schema section to bot configuration#1018
docs: add JSON schema section to bot configuration#1018dotandev wants to merge 1 commit intoall-contributors:mainfrom
Conversation
✅ Deploy Preview for all-contributors ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
JimMadge
left a comment
JimMadge
left a comment
There was a problem hiding this comment.
I think this needs more work.
I don't think it is in the right section and it is missing an explanation of how to validate a configuration file against the schema, which is the most important thing to cover.
|
|
||
| ```json | ||
| { | ||
| "$schema": "https://www.schemastore.org/all-contributors.json", |
There was a problem hiding this comment.
I think this keyword is used in schema to specify which dialect is used. It might actually cause validation to fail as the schema doesn't expect this.
There was a problem hiding this comment.
I don't think this is the right place to put this documentation. It might be better as a new page in the specification section.
| Example `.all-contributorsrc` with `$schema` added: | ||
|
|
||
| ```json | ||
| { |
There was a problem hiding this comment.
Is this a duplicate of the example file on the same page? I don't think it is necessary to write that twice.
2 participants
What: Added a new "JSON Schema" section to the Bot Configuration documentation.
Why: This helps users validate their
.all-contributorsrcconfiguration file and provides auto-completion in compatible editors like VS Code, reducing setup errors.How: Updated
src/content/docs/bot/configuration.mdto include an explanation of the schema available on SchemaStore and a code example showing how to add the$schemaproperty.Checklist:
I've verified the changes locally using
npm run dev, and bothnpm run lintandnpm run buildpass.closes #1012