Getting Started with Astro Docs

Content last updated: 2025-01-09

A comprehensive guide to getting your first knowledge base setup. Read on to learn more!

Step 1 - Have a dedicated Confluence space ready

The first step is to have a dedicated confluence space ready. This space should have documentation that is ready for your customers to read and learn from.

It’s important that no internal documentation reside in this space, since it will be public to the internet.

In our example, I will be using this space titled “Help Center”:

Step 2 - Installation

Navigate to https://astro-docs.com/install and click on “Click here to install” this will walk you through the installation process.

Step 3 - Start indexing space

Click on the astro-docs app under the “Space apps” which will open Astro Docs for the first time, if the installation process doesn’t bring you to the app already.

You should see the following:

Using the dropdown menu, select the space you want to index. In our case, we will select the “Help Center” space.

Next, click “Start indexing selected space”. You should see a progress bar appear. Please wait until Astro Docs finishes indexing your space.

Once the indexing is complete, you will be presented with two options.

For now, we will select “Go to settings” before we visit our new site.

You should now see all of the pages in your indexed site in a table view. Each page is indexed, and by default, public. You can toggle the visibility of a page by clicking on “Hide page”. This will hide the page from search results, and return a 404 error when attempting to access it directly by URL. You can toggle the visibility back to public afterwards.

Step 4 - View your new site

Finally, click on “View your site” at the bottom of the page. You will be forwarded to your new public knowledge base. Feel free to browse around, perform searches, click on pages, etc.

Step 4 - View your site analytics

After browsing around your site and performing some searches, navigate back to Confluence and click on “Analytics”. This page will show you how many times a search term has come up, and how many results were displayed to the user.

That’s it! You’re officially setup with Astro Docs.