docs: add API documentation and restructure sidebar #4772
Conversation
This file contains 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
dosubot
bot
added
the
size:L
mendonk
changed the title
github-actions
bot
added
documentation
Comment on lines
+3
to
+6
| 'Getting-Started/welcome-to-langflow', | ||
| { | ||
| type: 'category', | ||
| label: 'Getting Started', |
There was a problem hiding this comment.
Per the Google style guide, avoid gerunds in titles. Use "Get started" instead.
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.
This pull request switches to the Docusaurus OpenAPI preset and updates the sidebar configuration. The most important changes include modifying the Docusaurus configuration to use
docusaurus-preset-openapi, adding new dependencies topackage.json, and restructuring the sidebar configuration.Changes to Docusaurus configuration:
docs/docusaurus.config.js: Replaced@docusaurus/preset-classicwithdocusaurus-preset-openapiand added configuration for OpenAPI file and API docs route.Dependency updates:
docs/package.json: Addeddocusaurus-plugin-openapi-docs,docusaurus-preset-openapi, anddocusaurus-theme-openapi-docsas new dependencies.Sidebar restructuring:
docs/sidebars.js: Replaced the autogenerated sidebar with a manually defined structure, organizing documentation into categories such as Getting Started, Components, Agents, Configuration, Guides, Integrations, Starter Projects, Workspace, Contributing, Deployment, and API Reference.