Octri

docs home

Shows which guide is served at / and whether its sidebar is hidden. Without one, / opens your first page. This writes to the navigation draft, which also holds the home page and redirects. Readers see none of it until octri docs nav publish, the same as Publish in API Studio. See home page.

bash
octri docs home [show | set <guideId> | clear]

octri docs home set <guideId>

Drafts a guide as the home page.

Arguments

<guideId>stringrequired

The guide, from octri docs guides.

Flags

--hide-sidebarboolean

Shows the home page without the sidebar. --no-hide-sidebar brings it back.

octri docs home clear

Drafts removing the home page, the same as Remove as home page in API Studio.

Examples

Show the home page

bash
octri docs home
Output
✔ Loading home page

Docs home page
  page  none
  octri docs home set <guideId>: serve a guide at /
  • octri docs guides: List, read and publish the guides you've written.
  • octri docs nav: Print, replace and publish the site's navigation, home page and redirects.