---
title: Workflows
description: Compare dashboard editing, writing agent, Markdown, and CLI workflows for maintaining docs.
---
Radiant supports several ways to work on docs. You can edit visually in the
dashboard, ask the writing agent to make changes, edit Markdown source
directly, or use the CLI for local preview and Git-based review.
## Choose a workflow
Use the dashboard when you want a no-code editing path. Use the writing agent
when you want help drafting or revising docs. Use Markdown and the CLI when you
want direct file control, local preview, or Git review.
| Workflow | Best for | Requires |
| --- | --- | --- |
| Dashboard editing | Visual page edits, navigation changes, settings changes, and non-code contributors | Radiant access |
| Writing agent | Drafting, rewriting, cleanup passes, and multi-file docs updates from instructions | Radiant access |
| Markdown and CLI | Direct page-source edits, code review, local preview, and Git-based collaboration | GitHub repository access |
| Mixed | Teams that combine browser edits, agent changes, and local reviews | A clear publish and pull routine |
## Dashboard-first workflow
Use the dashboard editor when you want Radiant to handle the editing environment
for you.
Open the Radiant dashboard and go to the editor for your docs project.
Update pages in visual or source mode. Use doc settings when you need to
change global configuration such as branding, navigation, navbar, or footer.
Save changes to the current draft. If someone changed the same content while
you were editing, Radiant asks you to review the conflict before saving or
publishing.
When the draft is ready, publish it to your live docs site.
Open the dashboard Overview page to see the deployment start right away.
The deployment activity shows the dashboard editor update while the build is
running.
When the deployment shows Success, the updated docs site is live.
Dashboard-first editing works for both Radiant-managed projects and
GitHub-backed projects. In Radiant-managed projects, Radiant manages the docs
repository for you. In GitHub-backed projects, dashboard edits are saved through
the connected repository.
## Writing agent workflow
Use the writing agent when you want to describe the docs outcome in plain
language and let Radiant make the content changes.
In the dashboard editor, click **Writing agent**.
Describe the page, audience, and outcome you want.
```txt
Rewrite the Quickstart intro so it feels more confident and less tentative.
Keep the page short and preserve the existing steps.
```
Read the agent summary, inspect the changed files, and use follow-up
prompts when you want another pass.
Agent changes are applied to your draft. Publish the draft when the updated
docs are ready to go live.
## Markdown and CLI workflow
Use the CLI when you want to edit docs locally and review changes through Git.
Clone the repository that contains your docs source.
```bash
git clone https://github.com/my-org/my-docs-repo.git
cd my-docs-repo
```
If your docs root is a subfolder, change into the folder that contains
`docs.json`.
Run the CLI from the docs root:
```bash
npx radiant-docs
```
The CLI validates that `docs.json` exists, syncs your docs into a local
preview environment, and starts a hot-reloading dev server.
Edit `.mdx` page files, assets, or `docs.json`. Review the local preview
before you commit.
Commit your changes and push them to the connected repository.
```bash
git add .
git commit -m "Update docs"
git push
```
After you push, Radiant starts a deployment for the updated docs.
## Mixed workflow
Many teams combine workflows:
- Use the dashboard for small text changes, navigation updates, and doc settings.
- Use the writing agent for drafting, restructuring, and cleanup.
- Use the CLI for larger edits, branch-based review, and changes that benefit
from local tooling.
- Pull the latest repository changes before editing locally.
- Save or publish dashboard edits before starting a related local change.
If one person is editing a page in the dashboard while another person edits the
same file locally, the next save or publish may require conflict review.
## Next steps
Make your first change.
See how docs pieces fit.
Give the agent a task.
Write clean page source.
Start local preview.
Organize pages visually.