From c17f96d4e2fb41c0bd0d13858e05b1d13a69d41b Mon Sep 17 00:00:00 2001 From: Jeremiah Lowin <153965+jlowin@users.noreply.github.com> Date: Tue, 14 Oct 2025 19:38:21 -0400 Subject: [PATCH] Update docs (#2094) --- .github/workflows/run-tests.yml | 2 +- README.md | 3 ++ docs/community/showcase.mdx | 6 ++++ docs/docs.json | 59 ++++++++++++++++---------------- docs/getting-started/welcome.mdx | 9 ++--- 5 files changed, 45 insertions(+), 34 deletions(-) diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml index 80c39dfd1..892f8629d 100644 --- a/.github/workflows/run-tests.yml +++ b/.github/workflows/run-tests.yml @@ -1,4 +1,4 @@ -name: Run tests +name: Tests env: # enable colored output diff --git a/README.md b/README.md index e96b243e4..59f68e37d 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ *Made with ☕️ by [Prefect](https://www.prefect.io/)* [![Docs](https://img.shields.io/badge/docs-gofastmcp.com-blue)](https://gofastmcp.com) +[![Discord](https://img.shields.io/badge/community-discord-5865F2?logo=discord&logoColor=white)](https://discord.gg/uu8dJCgttd) [![PyPI - Version](https://img.shields.io/pypi/v/fastmcp.svg)](https://pypi.org/project/fastmcp) [![Tests](https://github.com/jlowin/fastmcp/actions/workflows/run-tests.yml/badge.svg)](https://github.com/jlowin/fastmcp/actions/workflows/run-tests.yml) [![License](https://img.shields.io/github/license/jlowin/fastmcp.svg)](https://github.com/jlowin/fastmcp/blob/main/LICENSE) @@ -70,6 +71,8 @@ There are two ways to access the LLM-friendly documentation: - [`llms.txt`](https://gofastmcp.com/llms.txt) is essentially a sitemap, listing all the pages in the documentation. - [`llms-full.txt`](https://gofastmcp.com/llms-full.txt) contains the entire documentation. Note this may exceed the context window of your LLM. +**Community:** Join our [Discord server](https://discord.gg/uu8dJCgttd) to connect with other FastMCP developers and share what you're building. + --- diff --git a/docs/community/showcase.mdx b/docs/community/showcase.mdx index c0a9e3545..fe8ec810d 100644 --- a/docs/community/showcase.mdx +++ b/docs/community/showcase.mdx @@ -6,6 +6,12 @@ icon: 'users' import { YouTubeEmbed } from '/snippets/youtube-embed.mdx' +## Join the Community + + + Connect with other FastMCP developers, share your projects, and discuss ideas. + + ## Featured Projects Discover exemplary MCP servers and implementations created by our community. These projects demonstrate best practices and innovative uses of FastMCP. diff --git a/docs/docs.json b/docs/docs.json index 758eca70f..334804ca5 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -9,10 +9,10 @@ "dark": "#222831", "light": "#EEEEEE" }, - "decoration": "windows" + "decoration": "gradient" }, "banner": { - "content": "Host your server on [FastMCP Cloud](https://fastmcp.cloud) for free!" + "content": "Join the [FastMCP community](https://discord.gg/uu8dJCgttd)!" }, "colors": { "dark": "#f72585", @@ -20,10 +20,7 @@ "primary": "#2d00f7" }, "contextual": { - "options": [ - "copy", - "view" - ] + "options": ["copy", "view"] }, "description": "The fast, Pythonic way to build MCP servers and clients.", "favicon": { @@ -32,9 +29,10 @@ }, "footer": { "socials": { - "bluesky": "https://bsky.app/profile/jlowin.dev", + "discord": "https://discord.gg/uu8dJCgttd", "github": "https://github.com/jlowin/fastmcp", - "x": "https://x.com/jlowin" + "website": "https://prefect.ai", + "x": "https://x.com/fastmcp" } }, "integrations": { @@ -56,6 +54,11 @@ "href": "https://fastmcp.cloud", "icon": "cloud", "label": "FastMCP Cloud" + }, + { + "href": "https://discord.gg/uu8dJCgttd", + "icon": "discord", + "label": "Discord" } ], "primary": { @@ -64,7 +67,7 @@ } }, "navigation": { - "tabs": [ + "dropdowns": [ { "groups": [ { @@ -72,7 +75,8 @@ "pages": [ "getting-started/welcome", "getting-started/installation", - "getting-started/quickstart" + "getting-started/quickstart", + "updates" ] }, { @@ -132,10 +136,7 @@ { "group": "Essentials", "icon": "cube", - "pages": [ - "clients/client", - "clients/transports" - ] + "pages": ["clients/client", "clients/transports"] }, { "group": "Core Operations", @@ -161,10 +162,7 @@ { "group": "Authentication", "icon": "user-shield", - "pages": [ - "clients/auth/oauth", - "clients/auth/bearer" - ] + "pages": ["clients/auth/oauth", "clients/auth/bearer"] } ] }, @@ -240,18 +238,13 @@ "pages": [ "development/contributing", "development/tests", - "development/releases" + "development/releases", + "changelog" ] } ], - "tab": "Documentation" - }, - { - "pages": [ - "updates", - "changelog" - ], - "tab": "What's New" + "dropdown": "Documentation", + "icon": "book" }, { "anchors": [ @@ -437,7 +430,8 @@ ] } ], - "tab": "SDK Reference" + "dropdown": "SDK Reference", + "icon": "code" } ] }, @@ -454,7 +448,14 @@ "search": { "prompt": "Search the docs..." }, - "theme": "mint", + "theme": "almond", + "errors": { + "404": { + "redirect": false, + "title": "Don't panic.", + "description": "You’ve wandered outside the context." + } + }, "thumbnails": { "appearance": "light", "background": "/assets/brand/thumbnail-background.png" diff --git a/docs/getting-started/welcome.mdx b/docs/getting-started/welcome.mdx index bc03f0fb1..738f5d3ca 100644 --- a/docs/getting-started/welcome.mdx +++ b/docs/getting-started/welcome.mdx @@ -3,6 +3,7 @@ title: "Welcome to FastMCP 2.0!" sidebarTitle: "Welcome!" description: The fast, Pythonic way to build MCP servers and clients. icon: hand-wave +mode: wide ---