This is an automated email from the ASF dual-hosted git repository.
wenjin272 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-agents.git
The following commit(s) were added to refs/heads/main by this push:
new 7e009ca5 [docs] Improve the documentation index page and build
instructions (#1018)
7e009ca5 is described below
commit 7e009ca51cc982ddb2baecf0cb5c91bc0b5ec58f
Author: Weiqing Yang <[email protected]>
AuthorDate: Thu Aug 20 19:33:30 2026 -0700
[docs] Improve the documentation index page and build instructions (#1018)
Generated-by: Claude Code 2.1.233 (Claude Opus 5)
---
docs/README.md | 6 +++++-
docs/content.zh/_index.md | 2 +-
docs/content/_index.md | 14 +++++++++++++-
docs/setup_hugo.sh | 9 +++++++--
4 files changed, 26 insertions(+), 5 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index dcbf4611..a15fe076 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -22,12 +22,16 @@ $ docker run -v $(pwd):/src -p 1313:1313
jakejarvis/hugo-extended:latest server
#### Local Hugo installation:
-Make sure you have installed
[Hugo](https://gohugo.io/getting-started/installing/) on your system.
+`setup_hugo.sh` installs Hugo 0.110.0, the version the docs build is pinned
to. A newer Hugo release removed an internal template the pinned `hugo-book`
theme calls, so building with a current Hugo fails with `no such template
"_internal/google_analytics_async.html"`.
+
+On Linux, install it with:
```sh
$ ./setup_hugo.sh
```
+`setup_hugo.sh` downloads a Linux binary, x86_64 or ARM64. On other platforms,
install the extended Hugo 0.110.0 from the [Hugo releases
page](https://github.com/gohugoio/hugo/releases/tag/v0.110.0) yourself.
+
Then build the docs from source:
```sh
diff --git a/docs/content.zh/_index.md b/docs/content.zh/_index.md
index 33bbd108..b25810ae 100644
--- a/docs/content.zh/_index.md
+++ b/docs/content.zh/_index.md
@@ -41,7 +41,7 @@ under the License.
### Community Sync
-我们每周会举行一次在线同步会议，欢迎所有人参与。请查看此 [GitHub
讨论页面](https://github.com/apache/flink-agents/discussions/66)
获取下次会议的时间表、议程以及往期会议记录。
+我们每周会举行一次在线同步会议，欢迎所有人参与。请查看此 [GitHub
讨论页面](https://github.com/apache/flink-agents/discussions/419)
获取下次会议的时间表、议程以及往期会议记录。
{{< /columns >}}
diff --git a/docs/content/_index.md b/docs/content/_index.md
index 4ed63a5a..2adfcb43 100644
--- a/docs/content/_index.md
+++ b/docs/content/_index.md
@@ -30,6 +30,18 @@ under the License.
If you’re interested in playing around with Flink Agents, check out our [get
started documentation]({{< ref "docs/get-started/overview" >}}).
It provides a step by step introduction on how to install Flink Agents and
build agents with it.
+### Quickstart
+
+* [Workflow Agent]({{< ref "docs/get-started/quickstart/workflow_agent" >}}) -
Define agent logic as an explicit event-driven workflow
+* [ReAct Agent]({{< ref "docs/get-started/quickstart/react_agent" >}}) - Let
the model plan and call tools in a reason-act loop
+* [YAML Agent]({{< ref "docs/get-started/quickstart/yaml_agent" >}}) -
Configure an agent declaratively in YAML
+
+### Build and Operate
+
+* [Chat Models]({{< ref "docs/development/chat_models" >}}), [Tools]({{< ref
"docs/development/tool_use" >}}) and [Memory]({{< ref
"docs/development/memory/overview" >}}) - The building blocks of an agent
+* [Integrate with Flink]({{< ref "docs/development/integrate_with_flink" >}})
- Run an agent inside a Flink job
+* [Deployment]({{< ref "docs/operations/deployment" >}}) and [Monitoring]({{<
ref "docs/operations/monitoring" >}}) - Take an agent to production
+
<--->
## Get Help with Flink Agents
@@ -44,7 +56,7 @@ See the [Apache Flink
website](https://flink.apache.org/what-is-flink/community/
### Community Sync
-There is a weekly online sync. Everyone is welcome to join. Please find the
schedule, agenda for the next sync, and records of previous syncs in this
[github discussion page](https://github.com/apache/flink-agents/discussions/66).
+There is a weekly online sync. Everyone is welcome to join. Please find the
schedule, agenda for the next sync, and records of previous syncs in this
[github discussion
page](https://github.com/apache/flink-agents/discussions/419).
{{< /columns >}}
diff --git a/docs/setup_hugo.sh b/docs/setup_hugo.sh
index 5f3fa290..015b228b 100644
--- a/docs/setup_hugo.sh
+++ b/docs/setup_hugo.sh
@@ -18,8 +18,13 @@
################################################################################
# setup hugo
-HUGO_REPO=https://github.com/gohugoio/hugo/releases/download/v0.110.0/hugo_extended_0.110.0_Linux-64bit.tar.gz
-HUGO_ARTIFACT=hugo_extended_0.110.0_Linux-64bit.tar.gz
+case "$(uname -m)" in
+ x86_64) HUGO_ARCH=Linux-64bit ;;
+ aarch64) HUGO_ARCH=linux-arm64 ;;
+ *) echo "No Hugo binary for architecture $(uname -m)" ; exit 1 ;;
+esac
+HUGO_ARTIFACT=hugo_extended_0.110.0_${HUGO_ARCH}.tar.gz
+HUGO_REPO=https://github.com/gohugoio/hugo/releases/download/v0.110.0/${HUGO_ARTIFACT}
if ! curl --fail -OL $HUGO_REPO ; then
echo "Failed to download Hugo binary"
exit 1
