Chore/convert-to-markdown #3
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![korbit-ai[bot]](https://avatars.githubusercontent.com/in/322216?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review by Korbit AI
Korbit automatically attempts to detect when you fix issues in new commits.
| Category | Issue | Status |
|---|---|---|
 |
Missing Function Purpose in JSDoc ▹ view | |
 |
Insufficient Error Context in Catch Block ▹ view | ✅ Fix detected |
 |
Quadratic Time Complexity in Heading Processing ▹ view | |
 |
Complex Nested Conditional Logic ▹ view | |
 |
Function Too Large with Multiple Responsibilities ▹ view | |
|
Complex Item Processing Logic Not Separated ▹ view | |
 |
Missing Warning Logs for Invalid YAML Structure ▹ view | |
|
Inefficient Array Lookup in Loop ▹ view | |
|
Unclear Technical Terminology ▹ view | |
 |
Incorrect Title Case Conversion ▹ view |
Files scanned
| File Path | Reviewed |
|---|---|
| docs/src/utils/yamlToMarkdown.js | ✅ |
| docs/src/utils/markdownToYaml.js | ✅ |
Explore our documentation to understand the languages and file types we support and the files we ignore.
Check out our docs on how you can make Korbit work best for you and your team.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description by Korbit AI
What change is being made?
Consolidate and rewrite the existing sidebar YAML documentation in Markdown format, and implement two scripts for converting between YAML and Markdown.
Why are these changes being made?
This change facilitates easier documentation updates for sidebar structures by allowing contributors to work in Markdown, a more accessible format for non-developers. The added conversion scripts,
yamlToMarkdown.jsandmarkdownToYaml.js, provide round-trip conversion capabilities, enabling seamless transitions between formats while maintaining comments and structure. This will streamline the content update process and improve workflow efficiency for teams using these schemas. The enhancement also includes a newpackage.jsonto manage dependencies.