docs: Add Categories and Tags section to API Catalog documentation#2463
Open
mosch wants to merge 1 commit into
Open
docs: Add Categories and Tags section to API Catalog documentation#2463mosch wants to merge 1 commit into
mosch wants to merge 1 commit into
Conversation
The category schema exposes both `label` and `tags`, but the distinction isn't obvious from the existing examples. Document that `label` drives the top-level filter chips while `tags` are secondary descriptors that only feed the search input and render as additional badges on the API card. https://claude.ai/code/session_01ByEFHH7udUHs9T4GgGYDY7
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Coverage Report
File CoverageNo changed files found. |
|
Preview build of published Zudoku package for commit 32ebe3f. See the deployment at: https://7cb49aa0.cosmocargo-public-package.pages.dev Note This is a preview of the Cosmo Cargo example using the Zudoku package published to a local registry to ensure it'll be working when published to the public NPM registry. Last updated: 2026-05-18T14:36:59.011Z |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation explaining how API Catalog category labels and tags affect filtering, search, and card badges.
Changes:
- Adds a “Categories and Tags” section before setup instructions.
- Defines
labelas the primary filter grouping andtagsas searchable secondary descriptors. - Includes a concrete category entry example.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
dan-lee
approved these changes
May 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Added a new "Categories and Tags" section to the API Catalog documentation that explains the distinction between
labelandtagsfields in thecategoriesarray, how they function in the UI, and provides a practical example.Changes
labelandtagsfieldslabelis the primary grouping mechanism that creates filter chipstagsare secondary descriptors used for search matching and rendered as badgesDetails
The new section is positioned early in the API Catalog documentation (after the introductory paragraph and before the "Enable API Catalog" section) to help users understand the core concepts before implementing the feature. The explanation uses clear language and formatting to distinguish between the two concepts and their respective roles in the UI.
https://claude.ai/code/session_01ByEFHH7udUHs9T4GgGYDY7