Skip to content

docs: add required frontmatter guide for community catalog pages #753

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

Open
agent-of-mkmeral wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add required frontmatter guide for community catalog pages #753

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
47 changes: 35 additions & 12 deletions src/content/docs/community/get-featured.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ We feature **reusable packages** that extend Strands Agents capabilities:
- **Model Providers** — integrations with LLM services (OpenAI-compatible endpoints, custom APIs, etc.)
- **Tools** — packaged tools that solve common problems (API integrations, utilities, etc.)
- **Session Managers** — custom session/memory implementations
- **Plugins** — extend or modify agent behavior during lifecycle events
- **Integrations** — protocol implementations, framework bridges, etc.

We're not looking for example agents or one-off projects — the focus is on packages published to PyPI that others can `pip install` or `npm install` and use in their own agents. See [Community Packages](./community-packages.md) for guidance on creating and publishing your package.
Expand All @@ -25,19 +26,20 @@ The [extension template](https://github.com/strands-agents/extension-template-py

1. **Create a PR** to [strands-agents/docs](https://github.com/strands-agents/docs)
2. **Add your doc file** in the appropriate `community/` subdirectory
3. **Update `src/config/navigation.yml`** to include your new page in the nav
3. **Include the required frontmatter** so your page appears in the [community catalog](./community-packages.md)
4. **Update `src/config/navigation.yml`** to include your new page in the nav

## Directory Structure

Place your documentation in the right spot:

| Type | Directory | Example |
|------|-----------|---------|
| Model Providers | `community/model-providers/` | `cohere.md` |
| Tools | `community/tools/` | `strands-deepgram.md` |
| Session Managers | `community/session-managers/` | `agentcore-memory.md` |
| Plugins | `community/plugins/` | `my-plugin.md` |
| Integrations | `community/integrations/` | `ag-ui.md` |
| Model Providers | `community/model-providers/` | `cohere.mdx` |
| Tools | `community/tools/` | `strands-deepgram.mdx` |
| Session Managers | `community/session-managers/` | `agentcore-memory.mdx` |
| Plugins | `community/plugins/` | `my-plugin.mdx` |
| Integrations | `community/integrations/` | `ag-ui.mdx` |

## Document Layout

Expand All @@ -48,7 +50,6 @@ Follow this structure (see existing docs for reference):
```markdown
# Package Name


Brief intro explaining what your package does and why it's useful.

## Installation
Expand All @@ -72,22 +73,40 @@ Common issues and how to fix them.
Links to your repo, PyPI, official docs, etc.
```

### For Tools
### Frontmatter

Every community page needs frontmatter with catalog fields so it appears in the [community catalog](./community-packages.md). Without `community: true`, `integrationType`, `description`, and `languages`, your page won't show up in the catalog tables.

Add frontmatter with project metadata:
Here's the full frontmatter for a **Tool** (adapt `integrationType` for your package type — `tool`, `model-provider`, `session-manager`, `plugin`, or `integration`):

```yaml
---
title: your-package-name
community: true
integrationType: tool
description: Short description of what the tool does
languages: Python
sidebar:
label: "display-name"
project:
pypi: https://pypi.org/project/your-package/
github: https://github.com/your-org/your-repo
maintainer: your-github-username
service:
name: service-name
name: Service Name
link: https://service-website.com/
---
```

| Field | Required | Notes |
|-------|----------|-------|
| `community` | ✅ | Must be `true` |
| `integrationType` | ✅ | `tool`, `model-provider`, `session-manager`, `plugin`, or `integration` |
| `description` | ✅ | Shown in the catalog table |
| `languages` | ✅ | `Python`, `TypeScript`, or omit for both |
Copy link
Copy Markdown

@opieter-aws opieter-aws Apr 16, 2026

Choose a reason for hiding this comment

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

nit because out of scope for this documentation update, but it's confusing that a languages field doesn't accept a list

| `project` | Recommended | PyPI/npm link, GitHub repo, maintainer |
| `service` | Optional | External service metadata |

## Update navigation.yml

Add your page to `src/config/navigation.yml` under the Community section:
Expand All @@ -107,8 +126,12 @@ Add your page to `src/config/navigation.yml` under the Community section:

## Examples to Follow

- **Model Provider**: [fireworksai.md](https://github.com/strands-agents/docs/blob/main/docs/community/model-providers/fireworksai.md)
- **Tool**: [strands-deepgram.md](https://github.com/strands-agents/docs/blob/main/docs/community/tools/strands-deepgram.md)
Look at existing community pages for reference:

- **Tool**: [strands-deepgram.mdx](https://github.com/strands-agents/docs/blob/main/src/content/docs/community/tools/strands-deepgram.mdx)
- **Model Provider**: [nvidia-nim.mdx](https://github.com/strands-agents/docs/blob/main/src/content/docs/community/model-providers/nvidia-nim.mdx)
- **Session Manager**: [agentcore-memory.mdx](https://github.com/strands-agents/docs/blob/main/src/content/docs/community/session-managers/agentcore-memory.mdx)
- **Integration**: [ag-ui.mdx](https://github.com/strands-agents/docs/blob/main/src/content/docs/community/integrations/ag-ui.mdx)

## Questions?

Expand Down
Loading