Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pubrio.com/llms.txt

Use this file to discover all available pages before exploring further.

​
CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

​
What This Repo Is

Pubrio API documentation site built with Mintlify. Content is written in MDX and served via Mintlify’s hosted platform. Changes pushed to main are automatically deployed to production.

​
Development Commands

# Install Mintlify CLI (one-time)
npm i -g mintlify

# Preview docs locally (run from repo root where docs.json lives)
mintlify dev

# If dev server fails to start
mintlify install  # re-installs dependencies

​
Architecture

​
Configuration

  • docs.json — main Mintlify config (theme, navigation, languages, logo, navbar, footer). This is the single source of truth for site structure. Any new page must be registered here under the appropriate language’s navigation tree.

​
Multilingual Structure

Content is organized by language code at the top level:
DirectoryLanguage
en/English
cn/Chinese (Simplified)
jp/Japanese
ko/Korean
Each language directory mirrors the same structure:
  • get-started/ — introduction, pricing, use cases, user guides
  • api-reference/ — authentication, rate limits, status codes, endpoint pages
  • knowledge-base/ — guides, concepts, case studies
  • resources/ — changelog, roadmap, careers, affiliate program

​
OpenAPI Specs

Each language has its own OpenAPI spec file:
  • en/api-reference/en-openapi.json
  • cn/api-reference/cn-openapi.json
  • jp/api-reference/jp-openapi.json
  • ko/api-reference/ko-openapi.json
Endpoint pages reference these specs. When updating API endpoints, the OpenAPI JSON and the corresponding MDX pages in all four languages typically need to stay in sync.

​
API Endpoint Groups (in docs.json navigation)

  • Profile (Workspace) — profile info and usage
  • Enrichment — company/people data enrichment
  • Lookalike — similar company lookup
  • Lookup — company, people, job, news, LinkedIn, technology, advertisements, similar
  • Search — company, people, job, news, advertisements
  • Redeem — people redemption (single, batch, batch query)
  • LinkedIn — company and people LinkedIn lookup
  • Channels — template types and CRUD operations
  • Filters — technologies, locations, company size, departments, verticals, news categories, timezones
  • Miscellaneous — timezones

​
Adding a New Page

  1. Create the .mdx file in the appropriate language directory
  2. Register it in docs.json under the correct language → anchor → tab → group → pages array
  3. If supporting all languages, repeat for en/, cn/, jp/, ko/

​
Reusable Snippets

Shared content lives in {lang}/snippets/ and can be imported into MDX files using Mintlify’s snippet syntax.

​
Mintlify documentation

​
Working relationship

  • You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
  • ALWAYS ask for clarification rather than making assumptions
  • NEVER lie, guess, or make up anything

​
Project context

  • Format: MDX files with YAML frontmatter
  • Config: docs.json for navigation, theme, settings
  • Components: Mintlify components

​
Content strategy

  • Document just enough for user success - not too much, not too little
  • Prioritize accuracy and usability
  • Make content evergreen when possible
  • Search for existing content before adding anything new. Avoid duplication unless it is done for a strategic reason
  • Check existing patterns for consistency
  • Start by making the smallest reasonable changes

​
docs.json

  • Refer to the docs.json schema when building the docs.json file and site navigation

​
Frontmatter requirements for pages

  • title: Clear, descriptive page title
  • description: Concise summary for SEO/navigation

​
Writing standards

  • Second-person voice (“you”)
  • Prerequisites at start of procedural content
  • Test all code examples before publishing
  • Match style and formatting of existing pages
  • Include both basic and advanced use cases
  • Language tags on all code blocks
  • Alt text on all images
  • Relative paths for internal links

​
Git workflow

  • NEVER use —no-verify when committing
  • Ask how to handle uncommitted changes before starting
  • Create a new branch when no clear branch exists for changes
  • Commit frequently throughout development
  • NEVER skip or disable pre-commit hooks

​
Do not

  • Skip frontmatter on any MDX file
  • Use absolute URLs for internal links
  • Include untested code examples
  • Make assumptions - always ask for clarification