Enterprise Quick Start
Get your organization started with ReadMe
Welcome to ReadMe Enterprise. This quick start is designed to help you get familiar with the platform. Whether you're setting up with your CSM or exploring on your own, these guides will give you a solid foundation before diving into the rest of the Enterprise documentation.
We recommend following the pages in order, but you can jump to the section most relevant to your needs.
What You'll Accomplish
By the end of this quick start you will have a clear understanding of:
- How your Enterprise Group is structured and what it controls
- How projects sit within your Group and how to configure them
- The different paths available for adding and managing content in ReadMe
From there, you'll be ready to follow the detailed guides for each area of your Enterprise setup.
Quick Start Guides
Understand Group vs. Projects and how to configure your Group settings.
Set up your projects, manage access, and configure project settings.
Learn how write docs in ReadMe or sync them from GitHub.
What's Next
Once you've completed the quick start, here are good next steps depending on your priorities:
- Set up authentication - Configure SSO, OAuth, or custom login for your projects. See Authentication & Access.
- Connect GitHub - Set up bi-directional sync to manage docs alongside your code. See Sync with GitHub.
- Configure your Global Landing Page - Set up the entry point that houses all of your projects under your custom domain. See Creating a Global Landing Page.
- Invite your team - Add teammates and assign roles across your Group and projects. See Teammates and Roles.
Need additional support? Contact your CSM or reach out to [email protected] at any stage of setup.
Updated 3 days ago