Where Is the Macro Documentation Located? A Complete Guide to Finding the Source Files

The Macro documentation lives in the apps/docs directory of the macro-inc/macro repository, with additional reference materials scattered across packages/sdk/README.md and docs/STYLE_GUIDE.md.

The Macro platform maintains all documentation inside its monorepo, making it version-controlled alongside the codebase. This approach ensures documentation stays synchronized with code changes and allows developers to contribute updates through standard pull requests.

Primary Location: The apps/docs Directory

All public-facing documentation is housed in apps/docs, a dedicated application folder built with the Mintlify static-site generator. This directory contains the full set of Markdown and MDX files that power https://docs.macro.com.

Key Files in apps/docs

File	Purpose
apps/docs/README.md	Project overview and local build instructions
apps/docs/index.mdx	Homepage layout and navigation entry point
apps/docs/concepts/*.mdx	Core concept explanations (blocks, mentions, properties)
apps/docs/changelog/*.mdx	Chronological release notes
apps/docs/**/*.mdx	Guides, API references, and developer tutorials

According to the macro-inc/macro source code, the Mintlify configuration in this directory controls site structure, theming, and deployment behavior.

Auxiliary Documentation Locations

Beyond the main docs application, several other locations contain authoritative reference material:

• packages/sdk/README.md — TypeScript SDK usage guide and API reference
• docs/STYLE_GUIDE.md — Internal conventions for code, commits, and documentation
• README.md (repo root) — High-level product description with quick-start links

Accessing Documentation Programmatically

Since all documentation files are plain Markdown/MDX stored in GitHub, you can fetch them directly via the raw content API.

Fetch a Concept Page (Node.js)

import fetch from 'node-fetch';

// Retrieve the "blocks" concept page source
const url = 'https://raw.githubusercontent.com/macro-inc/macro/main/apps/docs/concepts/blocks.mdx';
const response = await fetch(url);
const markdown = await response.text();

console.log(markdown.slice(0, 200));

This pattern works for any file in apps/docs — simply adjust the path in the URL.

Construct Documentation URLs with the SDK

import { Macro } from '@macro/sdk';

const macro = new Macro({});

function docsUrl(relativePath: string): string {
  return `https://docs.macro.com/${relativePath}`;
}

const propertiesLink = docsUrl('concepts/properties');
console.log(propertiesLink); // https://docs.macro.com/concepts/properties

While the SDK does not bundle documentation, it exposes the base URL for constructing links in UI components or automated messages.

Running Documentation Locally

To preview or edit the Macro documentation on your machine:

cd apps/docs
npm install
npm run dev

This starts a Vite-based development server (typically at http://localhost:5173) with hot-reload for MDX files. The apps/docs/README.md file contains additional build commands and troubleshooting guidance.

Direct Links to Authoritative Sources

Resource	GitHub URL
Main documentation folder	https://github.com/macro-inc/macro/tree/main/apps/docs
SDK reference	https://github.com/macro-inc/macro/blob/main/packages/sdk/README.md
Style guide	https://github.com/macro-inc/macro/blob/main/docs/STYLE_GUIDE.md
Root README	https://github.com/macro-inc/macro/blob/main/README.md

Summary

• The primary Macro documentation is located in apps/docs as Markdown/MDX source files
• Documentation is built with Mintlify and deployed to https://docs.macro.com
• SDK documentation lives separately in packages/sdk/README.md
• Style and contribution guidelines are in docs/STYLE_GUIDE.md
• All sources are version-controlled in the main branch of macro-inc/macro

Frequently Asked Questions

Where is the Macro documentation source code stored?

The source code for the Macro documentation is stored in the apps/docs directory of the macro-inc/macro GitHub repository. These Markdown and MDX files are compiled into the public site at docs.macro.com using Mintlify.

Can I run the Macro documentation site locally?

Yes. Navigate to apps/docs, run npm install to install dependencies, then npm run dev to start a local development server. The apps/docs/README.md file contains complete setup instructions.

What is the difference between apps/docs and packages/sdk/README.md?

The apps/docs directory contains comprehensive user guides, concept explanations, and changelogs for the entire Macro platform. The packages/sdk/README.md is specifically focused on the TypeScript SDK client library — installation, authentication, and API methods.

How does Mintlify fit into the Macro documentation workflow?

Mintlify is the static-site generator that transforms the Markdown/MDX files in apps/docs into the deployed documentation website. It handles navigation, search, theming, and production builds when you run just build or npm run docs.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}