Introduction
Building Great API Docs\r\n
- Documentation & the API Ecosystem
- Three Principles for Great Documentation
- Documentation in Disguise
- The API Journey
- Topical Guides
- Reference Guides
\r\n
Q&A\r\n
- What ReadMe Does
- Differentiating from Swagger
- Series-A Recommendation for Support
- Thoughts about Nontraditional APIs
- Producing Consistent Documentation
- Best Practices for Integrating Organization
- Gitbook and Their Place in the Ecosystem
\r\n

",{"_103":7259,"_7159":7260,"_24":7161},{"_103":7257,"_7159":7258,"_24":7161},{"_103":7255,"_7159":7256,"_24":7161},"OGbdGTZ7UNM4","246787e2-94b8-475e-86fc-b7979814b9e9","F7Q5OejurWQU","0cc96902-f1bf-4fc7-a63e-73a7f4fc721e","zCPRpdwqUHBj","73c55bad-99db-4c07-a85a-a14c55070868","items",[7317,7318,7319],"recent",[7265,7266,7267],{"_7268":7303,"_89":7304,"_7241":-5,"_7272":7305,"_48":7306,"_14":7307,"_7276":7277,"_59":7308,"_7279":7280},{"_7268":7289,"_89":7290,"_7241":-5,"_7272":7291,"_48":7292,"_14":7293,"_7276":7277,"_59":7294,"_7279":7280},{"_7268":7269,"_89":7270,"_7241":7271,"_7272":7273,"_48":7274,"_14":7275,"_7276":7277,"_59":7278,"_7279":7280},"content",[7281],17,"https://cdn.sanity.io/images/50q6fr1p/production/28801f05c737cc57c3c04d467a0a54838fc70ad0-1200x630.png","objectID","9d8377ac-25e6-47b7-8e40-22ee9a7cb43e","2026-08-27T16:38:00.000Z","understanding-code-by-treating-it-as-a-graph","templateType","default","Is the Key to Understanding Code Treating it as a Graph?","typeName","blogArticle",{"_103":7282,"_24":257,"_258":7283,"_260":7284,"_262":263},"d8cde6678d08",[7285],[],{"_103":7286,"_24":276,"_277":7287,"_279":7288},"27e674f3e7de",[],"Treating software as a graph may be the key to quickly understanding and maintaining software in the age of AI. Open-source creator Vitali Avagyan explains.",[7295],20,"7f2db4aa-8e93-45db-a467-a326acd92cfb","2026-10-02T19:09:00.000Z","long-horizon-agents-part-2-memory-is-more-than-recall","Long-Horizon Agents, Part 2: Memory Is More than Recall",{"_103":7296,"_24":257,"_258":7297,"_260":7298,"_262":263},"82f5581705a2",[7299],[],{"_103":7300,"_24":276,"_277":7301,"_279":7302},"4283a07b60d3",[],"Agents need persistent memory to become performant for long-horizon jobs. Amir Zohrenejad surveys the state of agentic memory and covers what’s missing.",[7309],16,"616147c4-aa4e-4ab9-83ae-f20398e6871d","2026-10-20T16:48:00.000Z","how-to-orchestrate-multiple-agents-from-the-terminal","How to Orchestrate Multiple Agents from the Terminal",{"_103":7310,"_24":257,"_258":7311,"_260":7312,"_262":263},"19b8b2c958d1",[7313],[],{"_103":7314,"_24":276,"_277":7315,"_279":7316},"0cbb628f4fd2",[],"Open-source creator Gaurav Gosain explains how his work with terminal multiplexers led him to build multi-agent orchestration.",{"_7268":7348,"_89":7349,"_7241":7350,"_7272":7260,"_7351":7352,"_48":7353,"_14":7354,"_59":7355,"_7279":25},{"_7268":7335,"_89":7336,"_7241":7322,"_7272":7258,"_48":7337,"_14":7338,"_59":7339,"_7279":7326},{"_7268":7320,"_89":7321,"_7241":7322,"_7272":7256,"_48":7323,"_14":7324,"_59":7325,"_7279":7326},[7327],"59:57","https://cdn.sanity.io/images/50q6fr1p/production/7ea1ac95f080e818e315f3d91637dfc40a2b5855-3000x3000.jpg","2025-08-01T07:10:00.000Z","platform-builders/ep-11-how-llms-are-changing-pr-forever-with-greg-galant","Platform Builders Ep. #11, How LLMs Are Changing PR Forever with Greg Galant","podcastEpisode",{"_103":7328,"_24":257,"_258":7329,"_260":7330,"_262":263},"a87959de206c",[7331],[],{"_103":7332,"_24":276,"_277":7333,"_279":7334},"ae2d62de5d88",[],"In episode 11 of Platform Builders, Christine Spang and Isaac Nassimi chat with Greg Galant. Greg recounts his early entrance into podcasting, social media, and eventually PR tech. He shares war stories from the early 2000s, including launching a podcast before “podcasting” was popular, creating the viral Shorty Awards, and bootstrapping Muck Rack into a multi-million dollar SaaS company. The conversation offers a unique lens on innovation, timing, media evolution, and how AI is reshaping earned media.",[7340],"49:27","2025-09-22T07:10:00.000Z","platform-builders/ep-14-navigating-restaurant-tech-s-roadmaps-with-anthony-presley","Platform Builders Ep. #14, Navigating Restaurant Tech’s Roadmaps with Anthony Presley",{"_103":7341,"_24":257,"_258":7342,"_260":7343,"_262":263},"73093953c176",[7344],[],{"_103":7345,"_24":276,"_277":7346,"_279":7347},"97510bdd4be0",[],"On episode 14 of Platform Builders, Christine Spang and Isaac Nassimi speak with Anthony Presley. Anthony walks through his journey from early consulting to creating workforce management SaaS, highlighting how persistence and customer-driven development shaped his companies. Together, they dig into the complexities of restaurant software, the importance of open ecosystems, and where dining tech is headed.",[7356],1021.4204,"https://image.mux.com/a5Ak6m4e02f3ETs5cgQ65pHEsBTdIO400Y/thumbnail.png","poster","mux","2025-09-25T16:00:00.000Z","sourcegraph-s-quinn-slack-on-founder-folklore","Sourcegraph's Quinn Slack on Founder Folklore",{"_103":7357,"_24":257,"_258":7358,"_260":7359,"_262":263},"6adc6b26ac77",[7360],[],{"_103":7361,"_24":276,"_277":7362,"_279":7363},"7ceaac68ea30",[],"Sourcegraph CEO Quinn Slack argues that in the AI era, founders must abandon outdated playbooks, move radically faster, and stay hands-on with product to survive constant change.",{"_103":7365,"_24":257,"_258":7366,"_260":7367,"_262":263},"698372246d42",[7368],[],{"_103":7369,"_24":276,"_277":7370,"_279":67},"698372246d420",[],"2023-04-21T21:45:14Z","7e3a37a4-a56d-440a-85a2-de52431c5fde","3wgj8X5vear6qceF9bUPYZ","2024-11-12T22:18:04Z","ctaType","email","decoration","decorationPosition","top_left",[7386],"file","Subscribe Now","https://share.hsforms.com/1_KYaR4lAQm-C8_9H7r4MIwqdoyu","Subscribe to Heavybit Updates","override",{"_103":7387,"_24":257,"_258":7388,"_260":7389,"_262":263},"481da9627862",[7390],[],{"_103":7391,"_24":276,"_277":7392,"_279":7393},"4eeeef09e3560",[],"You don’t have to build on your own. We help you stay ahead with the hottest resources, latest product updates, and top job opportunities from the community. Don’t miss out—subscribe now.","ua","Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)","hideBanner",{"_7416":7417,"_7418":7419,"_7420":7421,"_7422":7423},"ENV",{"_7400":7401,"_7402":7403,"_7404":7405,"_7406":7407,"_7408":7409,"_7410":7411,"_7412":7413,"_7414":7401,"_7415":7401},"SANITY_DATASET","production","ALGOLIA_INDEX","heavybit-library","ALGOLIA_APPLICATION_ID","0QCKBC1FMK","ALGOLIA_SITEWIDE_INDEX","heavybit-sitewide","ALGOLIA_JOBS_INDEX","heavybit-jobs","MUX_ENV_KEY","dRI98bL8ze03gYDL6-Ogle2Js","ALGOLIA_SEARCH_API_KEY","7733fdd199ec7af7ee2923ec39c3f036","MODE","VITE_CONTEXT","footer",{"_7573":7574,"_7575":7576,"_7164":7577},"globalConfig",{"_68":7570},"header",{"_7459":7460,"_7461":7462},"skills",{"_7424":7425,"_7426":7427,"_7428":7429,"_7430":7431,"_7432":7427,"_7433":7434,"_7435":7436,"_7437":7438,"_7439":7440,"_7441":7442,"_7443":7444,"_7445":7446,"_7447":7448},"cardButtonText","View skill","connectHeading","Connect your agent","connectSteps","Add the endpoint below to your harness: Claude Code, Codex, Claude, Cursor, ChatGPT, or another that supports MCP.\nSign in to your Heavybit account with Google or GitHub when your agent asks. It's free, and your first sign-in creates the account.\nTell your agent what you're working on. It finds the right skill, or you can ask for one by name.","crucibleCta",{"_7126":7449,"_7215":7427,"_1373":7434,"_59":7450},"crucibleLabel","crucibleUrl","https://crucible.heavybit.com/mcp","drawsFromLabel","Built from what these operators shared","explainerBody","A skill is a set of working instructions your agent loads when you need it, built from the strategies operators shared in the Heavybit Library. It guides the work and you still do it. Heavybit reads and approves every skill before it ships, and keeps updating skills as new content enters the Library. Skills are plain text, so you or your agent can read any skill in full before acting on it. Your agent decides how to apply a skill, so check its work; if a skill gets something wrong, ask your agent to report it or email platform@heavybit.com.","explainerHeading","What a skill is","searchPlaceholder","Search skills: pricing, launch, SOC 2...","skillEyebrow","Heavybit Skill","sourcesHeading","Built from the Heavybit Library","sourcesIntro","The operators behind this skill shared what they know in these talks, podcasts, and articles. Every one is free in the Heavybit Library.",[7451],"Connect your agent to Crucible, Heavybit's MCP server",{"_103":7452,"_24":257,"_258":7453,"_260":7454,"_262":263},"intro",[7455],[],{"_103":7456,"_24":276,"_277":7457,"_279":7458},"intro0",[],"One endpoint gives your agent every Heavybit Skill, a search of the Heavybit Library, and a direct line to Heavybit. Sign in free with Google or GitHub. Skills load when your agent needs them, so there is nothing to download or update.","announcementBar",{"_7562":7563,"_7564":-5,"_7565":29,"_7566":7567,"_279":7568,"_83":7569},"headerNavLinks",[7463,7464,7465,7466,7467],{"_103":7543,"_7469":7544,"_7215":7545,"_1373":7546,"_7472":12,"_59":7547},{"_103":7528,"_7469":7529,"_7215":7530,"_1373":7531,"_7472":12,"_59":7532},{"_103":7510,"_7469":7511,"_7215":7512,"_1373":7513,"_7472":12,"_59":7514},{"_103":7474,"_7469":7475,"_7215":7476,"_1373":7477,"_7472":12,"_59":7478},{"_103":7468,"_7469":-5,"_7215":7470,"_1373":7471,"_7472":29,"_59":7473},"3702498a502c","dropdown","Contact","/press","mobileOnly","Navigate to contact page","4bec0dd665d4",[7479,7480,7481,7482,7483,7484,7485],"Library","/library","Navigate to library page",{"_103":7507,"_7215":7508,"_1373":7509,"_59":7508},{"_103":7503,"_7215":7504,"_1373":7505,"_59":7506},{"_103":7499,"_7215":7500,"_1373":7501,"_59":7502},{"_103":7495,"_7215":7496,"_1373":7497,"_59":7498},{"_103":7492,"_7215":7493,"_1373":7494,"_59":7493},{"_103":7489,"_7215":7490,"_1373":7491,"_59":7490},{"_103":7486,"_7215":7487,"_1373":7488,"_59":7487},"66773779036c","DevToolsDigest","/devtoolsdigest","2ead3bd14715","Reports","/reports","ac06751f0372","Collections","/library/collections","1f3fb936f3b9","Podcast Network","/library/podcasts","Navigate to podcasts page","6526c69f5260","Videos","/library?filter=videos","Watch educational videos in Heavybit's Library","63e48d609548","Articles","/library?filter=articles","Read educational articles in Heavybit's Library","76b0479bfae2","Skills","/library/skills","716b76469486",[7515,7516,7517],"Community","/community","Navigate to community page",{"_103":7525,"_7215":7526,"_1373":7527,"_59":7526},{"_103":7522,"_7215":7523,"_1373":7524,"_59":7523},{"_103":7518,"_7215":7519,"_1373":7520,"_59":7521},"23077fca0e2f","DevGuild","/devguild","Navigate to devguild page","1fb7c9c465d0","Advisors","/community/advisors","3a177efc4649","Events","/events","90b68b861c06",[7533,7534],"Portfolio","/portfolio","Navigate to portfolio page",{"_103":7539,"_7215":7540,"_1373":7541,"_59":7542},{"_103":7535,"_7215":7536,"_1373":7537,"_59":7538},"e50fa43ad2e7","Jobs","/jobs","Portfolio Company Jobs","d481fcbbd3af","Spotlights","/portfolio/spotlights","Navigate to spotlights page","a8d641babed2",[7548,7549,7550],"About","/about","Navigate to about page",{"_103":7558,"_7215":7559,"_1373":7560,"_59":7561},{"_103":7554,"_7215":7555,"_1373":7556,"_59":7557},{"_103":7551,"_7215":7552,"_1373":7471,"_59":7553},"84e68f9f5c33","News","Navigate to press page","3d279775d73b","FAQ","/faq","Navigate to FAQ page","964627410473","Team","/team","Navigate to team page","buttonText","RSVP","end","show","start","2026-10-20T21:46:59.960Z","🐺 [Oct 28] GitBlame: Werewolf Happy Hour @GitHub Universe","https://luma.com/gitblame-werewolf",{"_24":7241,"_69":7571},{"_7159":7572,"_24":7161},"image-32fdfae4fd13b8f9a3c5bf6b13a635068cb0ecbb-1332x529-png","emailSubscription",{"_7126":7645,"_7646":7383},"footerColumns",[7609,7610,7611],[7578,7579,7580,7581,7582],{"_103":7604,"_7584":7605,"_83":7606},{"_103":7599,"_7584":7600,"_83":7601},{"_103":7594,"_7584":7595,"_83":7596},{"_103":7589,"_7584":7590,"_83":7591},{"_103":7583,"_7584":7585,"_83":7586},"639729864c2d","icon",{"_24":7168,"_69":7587},"https://www.tiktok.com/@heavybitindustries",{"_7159":7588,"_24":7161},"image-48ac9473e30341c4bee9f6634b77b6f8f1dd6b2f-849x980-webp","a100f6448036",{"_24":7168,"_69":7592},"https://www.instagram.com/heavybitindustries/",{"_7159":7593,"_24":7161},"image-b38b7ee9ccd05f61ca43d5b29fe7058f822f87eb-512x512-webp","fae1cc0df5c6",{"_24":7168,"_69":7597},"https://www.youtube.com/c/heavybit",{"_7159":7598,"_24":7161},"image-6c548d2e815d1fb3b3077c9b8be1ec251e1bc418-512x512-png","5348b028f0d41c3dac62b3dd2b5531ee",{"_24":7168,"_69":7602},"https://www.linkedin.com/company/heavybit",{"_7159":7603,"_24":7161},"image-01bd92eb06873bdc30b1cb5f9c78b1ef5a9559d4-512x512-png","ee025c96397c",{"_24":7168,"_69":7607},"https://twitter.com/heavybit",{"_7159":7608,"_24":7161},"image-9d618da0948299428b29e5d499af3fa5369a24d2-20x20-svg",{"_103":7637,"_7613":7545,"_7261":7638},{"_103":7625,"_7613":7512,"_7261":7626},{"_103":7612,"_7613":7476,"_7261":7614},"ea618aa34610","heading",[7615,7616,7617,7618],{"_103":7622,"_7215":7623,"_1373":7477,"_59":7624},{"_103":7621,"_7215":7496,"_1373":7497,"_59":7498},{"_103":7620,"_7215":7487,"_1373":7488,"_59":7487},{"_103":7619,"_7215":7508,"_1373":7509,"_59":7508},"5656520aaacf","96a97ceba3a2","e1673433290e","c82a64edc4dd","Blog","Navigate to browse on library page","a584a6acf07b",[7627,7628,7629,7630],{"_103":7636,"_7215":7526,"_1373":7527,"_59":7526},{"_103":7635,"_7215":7519,"_1373":7520,"_59":7521},{"_103":7634,"_7215":7536,"_1373":7537,"_59":7538},{"_103":7631,"_7215":7632,"_1373":7633,"_59":7632},"e22bfa6b2330","Inclusion","/community/diversity-and-inclusion","feb038ce46a1","e2d5641ef7de","4358699f4ca4","30a87ef6e7c1",[7639,7640,7641],{"_103":7644,"_7215":7530,"_1373":7531,"_59":7532},{"_103":7643,"_7215":7559,"_1373":7560,"_59":7561},{"_103":7642,"_7215":7552,"_1373":7471,"_59":7553},"398a9b50e214","42666d0b3987","3dfef1283ab5","Unlock success from technical pioneers in software infrastructure. We send the best strategies, tools, and industry updates directly to your inbox.","targetURL"]

Building Great API Docs

Speakers