Your Documentation Hub Page

Once you publish your first doc, AssistCamp creates a documentation section on your website automatically. You do not need to create a page, build a template, or add a shortcode.

Where your documentation lives

Your documentation hub is at yoursite.com/docs/ by default. The word “docs” comes from the Documentation URL Slug setting, so if you change that setting to “help”, your hub moves to yoursite.com/help/.

Individual docs sit underneath the hub, so a doc called “Getting Started” would be at yoursite.com/docs/getting-started/.

What appears on the hub page

The hub page is the front door to your documentation. It lists your documentation categories so readers can browse into the area they need, and it includes a search box for finding a doc by name.

What appears on a single doc page

When a reader opens one of your docs, the page includes:

• The doc title and content, laid out for reading.
• A cover image, if you set one for that doc.
• Breadcrumbs, a small trail of links near the top showing where the reader is, so they can move back up to the category or the hub.
• An automatic table of contents, built from the heading blocks in your doc, so readers can jump straight to a section.
• A category sidebar, listing your categories with the number of docs in each, so readers can move sideways into another part of your documentation without going back to the hub.

Getting readers to your documentation

AssistCamp creates the documentation section, but it does not add a link to it in your site menu. Add that link yourself so visitors can find it:

1. Go to Appearance > Menus if you use a classic theme, or edit your site header in the Site Editor if you use a block theme.
2. Add a custom link pointing to yoursite.com/docs/ (using your own domain and your own slug).
3. Label it something plain such as “Docs”, “Help”, or “Support”.
4. Save your menu.

Making your documentation look right in your theme

AssistCamp works with both block themes and classic themes and inherits your site’s fonts and colours. If your documentation pages look unstyled or the layout is too narrow or too wide, the cause is usually your theme’s content width settings rather than AssistCamp itself.