This QuickStart guide shows you how to set up and deploy your Knowledge Base site in minutes.
After completing this guide, you will have a live Knowledge Base site ready to customize and expand.
Getting Started
After you complete the onboarding process, your Knowledge Base site automatically deploys to a unique URL with this format:
Find the button on the Home page to view your Knowledge Base.
Your site’s URL is available immediately. Use this URL for testing and sharing with your team while you are setting up your Doc's site.
Install Recorder
InstantDocs provides an AI recorder that automates video doc creation. It converts raw screen recordings into studio-quality video and publish-ready step-by-step Docs.
Chrome extension
Download extension to record video docs
Mac App
Using Mac? Install native recorder for better experience
Windows App
Using Windows? Install native recorder for better experience
Record Screen
Follow these steps to turn a live screen recording into polished, step-by-step docs and a shareable videos automatically.
Editors
InstantDocs offers two dedicated editors, one for the step-by-step doc, one for the video, so you can polish each asset independently before you hit Publish.
Doc Editor
A Notion-style editor that lets you tweak text, add snapshots, reorder, drop in rich blocks & much more.
Video Editor
A clean, timeline-based video editor to trim clips, add/edit intro/outros, add custom voiceovers and much more without pro skills.
Publish Changes
When you’re satisfied with your edits, select the Publish button in the top-right corner. Your changes are immediately deployed to your documentation site.
Preview Changes
Click the "eye" icon above your article to preview before publishing. After publishing, click the Globe icon next to the Publish button to open your article in your live KB.
Adding a custom domain
While your your-workspace.instantdocsbase.com subdomain works well for testing and development, most teams prefer using a custom domain for production documentation.
To add a custom domain, from your Knowledge Base menu or the home-page editor navigate to Knowledge Base Settings → Domains & Redirects.
Enter your domain (for example, `docs.your-company.com`) and follow the provided instructions to configure DNS settings with your domain provider.
Next Steps
Congratulations! You have successfully deployed your Knowledge Base site with InstantDocs. Here are suggested next steps to enhance your Knowledge Base:
Organize navigation
Structure your Knowledge Base with intuitive navigation with sections & collections to help users find what they need.
Customize your theme
Learn how to customize colors, add buttons, configure SEO and the overall appearance of your Knowledge Base site.
Edit script & voiceover
Learn how to edit script, add a different voiceover artist and keep it perfectly in sync with the video.
Customize your home page
Add sections and spotlight high-priority docs on your landing page for faster access.