Improve discoverability of docs-mcp-server by mentioning it in the documentation

Aperta Adatta ai principianti
  • Qualcosa non va?
#7,120 5 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
74/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Ambito
documentation

Direzione di ricerca

Inizia da docs/content/en/blog/mcp-server-intro.md e consulta la guida utente, il README e la guida per i contributor per scegliere una posizione permanente appropriata per la documentazione. Aggiungi un riferimento chiaro e un link al PipeCD Docs MCP Server per gli utenti di editor o agenti AI; il lavoro è completato quando compare al di fuori del post del blog sulla release nella documentazione ufficiale.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

kind/enhancement

What would you like to be added:

A permanent mention of the PipeCD Docs MCP Server in the official documentation (e.g., in the user guide or a "Tools" section), instead of only in the release blog post.

Currently, the only reference to it in this repo is the announcement blog post from May 2025 (docs/content/en/blog/mcp-server-intro.md). It is not mentioned in the README, the user guide, or the contributor guide.

Why is this needed:

Users searching the docs for how to use PipeCD with AI editors/agents (Cursor, Claude Code, etc.) have no way to discover that an official docs MCP server exists, unless they happen to read a blog post from 2025. Adding it to a permanent docs page would make the tool discoverable to the users it was built for.

I'm happy to send a PR for this if the maintainers agree on where it should be mentioned.

Lingua principale
Go
Stelle
1.4k
Fork
391
Merge medio
4g 1h
PR unite (30g)
58

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pipe-cd/pipecd

Tutte le issue di pipe-cd/pipecd

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.