Skip to content

[doc] Add YAML API documentation and quickstart example. #705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xintongsong merged 2 commits into from
May 27, 2026
Merged

[doc] Add YAML API documentation and quickstart example. #705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0badf30
[doc] Add YAML API documentation and quickstart example.
wenjin272 May 21, 2026
82c970f
[doc] Address YAML doc review comments
wenjin272 May 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/docs/development/chat_models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Chat Models
weight: 3
weight: 4
type: docs
---
<!--
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/development/embedding_models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Embedding Models
weight: 5
weight: 6
type: docs
---
<!--
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/development/integrate_with_flink.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Integrate with Flink
weight: 10
weight: 11
type: docs
---
<!--
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/development/mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: MCP
weight: 9
weight: 10
type: docs
---
<!--
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/development/memory/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Memory
bold: true
bookCollapseSection: true
weight: 7
weight: 8
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/development/prompts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Prompts
weight: 4
weight: 5
type: docs
---
<!--
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/development/tool_use.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Tool Use
weight: 8
weight: 9
type: docs
---
<!--
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/development/vector_stores.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Vector Stores
weight: 6
weight: 7
Copy link
Copy Markdown
Collaborator

@weiqingy weiqingy May 25, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

weight: 7 here ties with docs/content/docs/development/memory/_index.md, which is also pinned to weight: 7. At a tie, Hugo's sidebar order falls back to alphabetic path, so Memory and Vector Stores can swap depending on Hugo version. How do you feel about bumping Memory to 8 in the same PR so each entry in the development tree has a unique weight? Open to other ideas if there's a reason to keep Memory at 7.

type: docs
---
<!--
Expand Down
Loading
Loading