Logo
Docs

Quickstart

Use this quickstart to make your first docs change and confirm it is live.

Onboarding

When you sign up, Radiant sets up your docs project automatically.

  • If you connect GitHub, docs are created in your GitHub-backed project.
  • If you skip GitHub, docs are created in a Radiant-managed internal project.
  • In both cases, starter docs are already deployed and ready to edit.

Use the path that matches how you want to edit.

Make your first change

    Dashboard editor

Open the editor

In the Radiant dashboard, open Editor.

Make one small text change

Open any placeholder page and edit one heading or paragraph.

Commit the update

Click Commit Changes in the top-right.

Confirm it is live

Open your docs site and verify that single change appears.

Clone your docs repo

In terminal, go to the directory where you want to keep your local docs copy, then clone the repo.

git clone https://github.com/my-org/my-docs-repo.gitcd my-docs-repo

Start local preview from the repo root

Run this in the repo root where docs.json is located:

npx radiant-docs

After startup, open the local preview URL in your browser. The default is http://localhost:4321.

Edit one page

Update one heading or paragraph in an .mdx file and save. Confirm the change appears in your local preview at http://localhost:4321.

Commit and push

Commit the change in your repo and push so your docs can deploy.

git add .git commit -m "Update docs content"git push

After push, your updated docs automatically start deploying. Monitor deployment status from the Dashboard Overview page.

Next steps