docs

mcp
Guvenlik Denetimi
Basarisiz
Health Uyari
  • No license — Repository has no license file
  • Description — Repository has a description
  • Active repo — Last push 0 days ago
  • Low visibility — Only 5 GitHub stars
Code Basarisiz
  • execSync — Synchronous shell command execution in scripts/screenshots/capture.mjs
  • process.env — Environment variable access in scripts/screenshots/capture.mjs
Permissions Gecti
  • Permissions — No dangerous permissions requested

Bu listing icin henuz AI raporu yok.

SUMMARY

Developer docs for gtm-api (docs.gtm-api.com): LinkedIn API reference, guides, and MCP setup. Built with Mintlify.

README.md

gtm-docs

Developer documentation for gtm-api, served at docs.gtm-api.com:
quickstart, guides, MCP setup, and the generated reference for the whole public contract. The
largest part is the LinkedIn API reference (150 endpoints: accounts, people and company search,
messaging, enrichment, mass actions), next to the identity and orchestration services.

Related:

Layout

gtm.docs/
├── docs.json                  # navigation, theme, branding
├── index.mdx …                # hand-written pages (Guides, MCP, Changelog tabs)
├── api-reference/
│   ├── overview.mdx           # hand-written intro to the reference
│   └── {linkedin,id,orchestration}/openapi.yaml   # GENERATED, synced copies
├── sync-openapi.sh            # pulls the specs in from gtm.openapi.public
└── logo/, favicon.svg         # brand assets (same set as the app)

The api-reference specs are generated. Do not edit them here.

The three openapi.yaml files are byte-identical copies of
product/openapi/gtm.openapi.public/services/<svc>/openapi.yaml, which is itself projected
from the Zod MCP tool registry in product/mcp/gtm.mcp. The chain is one-way:

Zod registry  →  pnpm openapi:public  →  gtm.openapi.public  →  ./sync-openapi.sh  →  here

To update the reference: change the tool definition, regenerate
(cd product/mcp/gtm.mcp && pnpm openapi:public), then run ./sync-openapi.sh.
./sync-openapi.sh --check fails on any drift between the copies and the source; run it
before committing.

Preview locally

npm i -g mint
mint dev

mint dev serves the site on http://localhost:3000 and validates docs.json on start.

Writing rules

Every page ships under the monorepo writing rules (root CLAUDE.md "Writing style: no LLM
tells" and marketing/BRAND_RULES.md): no em or en dash as punctuation, no filler
vocabulary, no legacy-brand references, and the brand name is gtm-api everywhere. Run the
hard-fail greps from marketing/aeo/articles/04-ARTICLE-CHECKLIST.md §1 and §2 over changed
pages before publishing.

Deploying

Push to main and the site rebuilds. That is the whole flow: Mintlify watches this repo
through its GitHub App, runs a Mintlify Deployment check on the push, and
docs.gtm-api.com picks the build up within about a minute.

This directory IS the standalone GitHub repo Mintlify watches: github.com/gtm-api/docs,
branch main (the branch is main, not master like the rest of the monorepo, because
Mintlify's connect wizard creates the repo itself from its template and seeds it that way).
The working copy lives inside the monorepo checkout at marketing/docs/gtm.docs/, gitignored
by the umbrella repo, so sync-openapi.sh keeps working: the monorepo checkout is its
expected home.

Workspace details, the domain setup and the connect-flow gotchas are in
marketing/aeo/DOCS_MINTLIFY_RUNBOOK.md.

Yorumlar (0)

Sonuc bulunamadi