Another round of improving mkdocs docs
Signed-off-by: Christian Tzolov <christian.tzolov@broadcom.com>
This commit is contained in:
parent
42887a8189
commit
5ebe61617b
3 changed files with 14 additions and 16 deletions
8
.github/workflows/docs.yml
vendored
8
.github/workflows/docs.yml
vendored
|
|
@ -39,9 +39,9 @@ jobs:
|
||||||
run: |
|
run: |
|
||||||
PROJECT_VERSION=$(mvn help:evaluate -Dexpression=project.version --quiet -DforceStdout)
|
PROJECT_VERSION=$(mvn help:evaluate -Dexpression=project.version --quiet -DforceStdout)
|
||||||
if [[ "${PROJECT_VERSION}" == *-SNAPSHOT ]]; then
|
if [[ "${PROJECT_VERSION}" == *-SNAPSHOT ]]; then
|
||||||
ALIAS="dev"
|
ALIAS="latest-snapshot"
|
||||||
else
|
else
|
||||||
ALIAS="prod"
|
ALIAS="latest"
|
||||||
fi
|
fi
|
||||||
mike deploy --push --update-aliases "${PROJECT_VERSION}" "${ALIAS}"
|
mike deploy --push --update-aliases "${PROJECT_VERSION}" "${ALIAS}"
|
||||||
mike set-default "${ALIAS}" --push
|
mike set-default "${ALIAS}" --push
|
||||||
|
|
@ -50,5 +50,5 @@ jobs:
|
||||||
if: github.event_name == 'release'
|
if: github.event_name == 'release'
|
||||||
run: |
|
run: |
|
||||||
VERSION=${GITHUB_REF_NAME}
|
VERSION=${GITHUB_REF_NAME}
|
||||||
mike deploy --push --update-aliases "${VERSION}" release
|
mike deploy --push --update-aliases "${VERSION}" latest
|
||||||
mike set-default release --push
|
mike set-default latest --push
|
||||||
|
|
|
||||||
10
README.md
10
README.md
|
|
@ -13,11 +13,11 @@ This SDK enables Java applications to interact with AI models and tools through
|
||||||
#### MCP Java SDK documentation
|
#### MCP Java SDK documentation
|
||||||
For comprehensive guides and SDK API documentation
|
For comprehensive guides and SDK API documentation
|
||||||
|
|
||||||
- [Features](https://modelcontextprotocol.github.io/java-sdk/dev/#features) - Overview the features provided by the Java MCP SDK
|
- [Features](https://modelcontextprotocol.github.io/java-sdk/#features) - Overview the features provided by the Java MCP SDK
|
||||||
- [Architecture](https://modelcontextprotocol.github.io/java-sdk/dev/#architecture) - Java MCP SDK architecture overview.
|
- [Architecture](https://modelcontextprotocol.github.io/java-sdk/#architecture) - Java MCP SDK architecture overview.
|
||||||
- [Java Dependencies / BOM](https://modelcontextprotocol.github.io/java-sdk/dev/quickstart/#dependencies) - Java dependencies and BOM.
|
- [Java Dependencies / BOM](https://modelcontextprotocol.github.io/java-sdk/quickstart/#dependencies) - Java dependencies and BOM.
|
||||||
- [Java MCP Client](https://modelcontextprotocol.github.io/java-sdk/dev/client/) - Learn how to use the MCP client to interact with MCP servers.
|
- [Java MCP Client](https://modelcontextprotocol.github.io/java-sdk/client/) - Learn how to use the MCP client to interact with MCP servers.
|
||||||
- [Java MCP Server](https://modelcontextprotocol.github.io/java-sdk/dev/server/) - Learn how to implement and configure a MCP servers.
|
- [Java MCP Server](https://modelcontextprotocol.github.io/java-sdk/server/) - Learn how to implement and configure a MCP servers.
|
||||||
|
|
||||||
#### Spring AI MCP documentation
|
#### Spring AI MCP documentation
|
||||||
[Spring AI MCP](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-overview.html) extends the MCP Java SDK with Spring Boot integration, providing both [client](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-client-boot-starter-docs.html) and [server](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-server-boot-starter-docs.html) starters.
|
[Spring AI MCP](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-overview.html) extends the MCP Java SDK with Spring Boot integration, providing both [client](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-client-boot-starter-docs.html) and [server](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-server-boot-starter-docs.html) starters.
|
||||||
|
|
|
||||||
12
mkdocs.yml
12
mkdocs.yml
|
|
@ -81,20 +81,18 @@ markdown_extensions:
|
||||||
- toc:
|
- toc:
|
||||||
permalink: true
|
permalink: true
|
||||||
|
|
||||||
plugins:
|
|
||||||
- search
|
|
||||||
- blog
|
|
||||||
|
|
||||||
extra:
|
extra:
|
||||||
version:
|
version:
|
||||||
provider: mike
|
provider: mike
|
||||||
alias: true
|
alias: true
|
||||||
default:
|
default:
|
||||||
- dev
|
- latest-snapshot
|
||||||
- latest
|
- latest
|
||||||
- prod
|
|
||||||
- release
|
|
||||||
social:
|
social:
|
||||||
- icon: fontawesome/brands/github
|
- icon: fontawesome/brands/github
|
||||||
link: https://github.com/modelcontextprotocol/java-sdk
|
link: https://github.com/modelcontextprotocol/java-sdk
|
||||||
generator: false
|
generator: false
|
||||||
|
|
||||||
|
plugins:
|
||||||
|
- search
|
||||||
|
- blog
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue