Home page

Any page can be your docs home page, served at the root of your site. This page is written that way: the one you land on at the root of these docs is an ordinary page.

Setting one

Open the page's ⋯ menu in the navigation and choose Set as home page. A home mark appears beside its name. The page stays where it is in the navigation, and its own address redirects to /.

The change takes effect when you publish. To undo it, choose Remove as home page on the same menu.

Hiding the sidebar

Turn on Hide sidebar on home page in the editor bar to drop the sidebar and the page outline at /, so the page reads as a front door. That option only appears on the home page.

With it on, the home page is also left out of every sidebar. With it off, the home page is listed like any other page.

Without a home page

If no page is set, the root of your site goes to your first page or your API reference.

In octri.json

{
  "navigation": {
    "home": {
      "page": "guides/welcome",
      "hideSidebar": true
    }
  }
}

page is the page's place in the navigation, as in its URL. See octri.json.

From the CLI

octri docs home shows which page is served at /, octri docs home set <guideId> picks one, and octri docs home clear goes back to the default.