Project Setup: Your Hub, Your Way
Overview
Welcome to Project Setup—where your developer hub takes shape! This section will guide you through configuring your ReadMe project so it perfectly reflects your API and delights your developers.
What You'll Find Here
🔧 Creating a Project
Get started with the essentials! Learn how to set up a new project, add your branding, and establish the foundation for stellar documentation. From choosing the perfect name to uploading your logo, we'll walk you through making your first ReadMe project feel like home.
👉 Create your first ReadMe project →
🧭 Navigating Your Hub
Help your developers find what they need—fast. Discover how to structure your navigation, organize your content, and create an intuitive information architecture that makes your API docs a joy to explore.
🔒 Setting Custom Domain & SSL
Brand consistency matters! Learn how to set up a custom domain that aligns with your company's web presence and secure it properly with SSL. We'll show you how to make your docs feel like an integrated part of your product ecosystem.
👉 Set up your branded domain →
⚙️ System Configuration
Fine-tune your project settings to match your team's workflow. From adjusting permissions to configuring webhooks, these settings help you tailor ReadMe to work seamlessly with your existing tools and processes.
👉 Configure your project settings →
📋 OpenAPI Support in ReadMe
Transform your OpenAPI specification into beautiful, interactive API reference documentation. Learn how to import, sync, and customize your API reference to create documentation that your developers will actually want to use.
🔐 Custom Login Page
Create a seamless authentication experience by customizing the login page for your docs. Control who has access to your documentation and provide a cohesive brand experience from login to logout.
👉 Customize your login experience →
🌐 ReadMe's Outbound IP Addresses
Set up proper security measures by understanding ReadMe's outbound IP addresses. This information is essential when configuring firewalls or allowlists for your API endpoints.
Why Project Setup Matters
A well-configured project isn't just about looks—it's about creating an experience that helps developers succeed with your API. Every setting you adjust here contributes to building documentation that's not only informative but also intuitive and engaging.
Ready to build a developer hub that your team can be proud of? Let's get started! 💪
Updated 1 day ago