Quickstart

Quickstart

This takes about ten minutes. You need a GitHub repository you can install an app on.

1. Create a workspace

   Sign up at https://app.staleless.com. A workspace holds your people, your billing and your projects. Name it after your company.

2. Create a project

   A project is one documentation property, such as Product Docs or an API reference. It owns its own pages, navigation, theme and domain.

3. Connect the repository

   Install the GitHub App and choose the organisation, the repository, the branch and the folder inside it. The folder is usually docs. See GitHub.

4. Write a page

   Open the writer. Create pages/guides/install.md, give it a title, and write a paragraph. Add it to nav.yaml, or the linter will refuse it as an orphan.

5. Publish

   Commit the change, then open the pull request. Read the diff, then merge. The merge publishes.

6. Connect your domain

   After the first publish, add your own hostname. See Domains.

What your repository looks like

docs/
├── nav.yaml           the navigation, and the order of everything
├── variables.yaml     {{product_name}} and other shared values
├── redirects.yaml     permanent moves
├── search.yaml        synonyms, aliases, pinned results, weights
├── glossary.yaml      the words to use, and the words not to
├── style.yaml         how the documentation is written
├── pages/             every page, as Markdown
└── snippets/          shared blocks, included by name

Only nav.yaml and pages/ are required.

Tip

Run npx staleless lint docs before you open the pull request. It needs no token and no network, so it works from a fork.