HonkingGoose
commented
2 weeks ago I think you meant for me to add these todos, so here's the list: 🙂
Docs: try content tabs with a single JSON tab first
- [ ] Keep using JSON in all our examples and code.
- [ ] Confirm we properly test for valid JSON examples in the docs.
- [ ] Enable and configure Material for MkDocs's content tabs feature, to prepare for later steps.
- [ ] Update docs to use Content Tabs for the current JSON, test docs keep working. Content tabs have a different format than our old plain JSON examples.
- [ ] Confirm linter correctly lints JSON in Content Tab layout.
Add/write JSON-to-YAML converter, insert YAML into content tab in docs
- [ ] Add code that converts valid JSON configuration examples to YAML, insert the YAML in a content tab.
- [ ] Write tests to confirm conversion from JSON to YAML works as intended.
- [ ] Confirm linter correctly lints JSON in content tab.
- [ ] Confirm linter correctly lints YAML in content tab.
- [ ] Use Material for MkDocs's content tabs feature to let users switch between JSON or YAML examples in the published docs.
Describe the proposed change(s).
Write a function to use jsonc-parser library to perform config migrations. We should use this for JSON configs initially, not JSON5. Later we can try JSONC migrations for .json5 files and then fall back to our old implementation if it fails to parse.
Important that we refactor our existing code (if necessary) so that same tests can be reused before/after the JSONC implementation to decrease chances of mistakes.