Skip to main content

After you complete this guide, you'll have a live documentation site ready to customize and update.

Before you begin

Docfiy uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation .

When you connect your documentation repository to your project, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.

Using an AI coding tool?

Copy the following prompt to add the Docfiy skill and MCP server for better results when updating your documentation.

Install the Docfiy skill and MCP servers for AI coding tools.

Open in Cursor

Deploy your documentation site

Go to docfiy.com/start and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments.

After onboarding, your documentation site deploys and is accessible at your .docfiy.com URL.

If you want to get started quickly without connecting your own repository, you can skip the Git provider connection during onboarding. Docfiy creates a private repository in a private organization and automatically configures the GitHub App for you.

This lets you use the web editor immediately. If you want to use your own repository later, go to Git Settings in your dashboard to migrate your content using the Git setup wizard. See Clone to your own repository for details.

View your deployed site

Your documentation site is now deployed at https://<your-project-name>.docfiy.com.

Find your exact URL on the Overview page of your dashboard.

Overview page of the Docfiy dashboard.

Your site is ready to view immediately. Use this URL for testing and sharing with your team. Before sharing with your users, you may want to add a custom domain.

Make your first change

1

Install the CLI

The CLI requires Node.js v20.17.0 or higher. Use an LTS version for stability.

npm i -g mint

See Install the CLI for full details and troubleshooting.

2

Clone your repository

If you haven't already cloned your repository locally, clone it using Git:

git clone <your-repository-url>

If your repository is in Docfiy's private organization, see Clone to your own repository to move it to your account first.

3

Edit a page

Open index.mdx in your preferred editor and update the description in the frontmatter:

---
title: "Introduction"
description: "Your custom description here"
---
4

Preview locally

Run the following command from your documentation directory:

docfiy dev

View your preview at http://localhost:3000.

5

Push your changes

Commit and push your changes to trigger a deployment:

git add .
git commit -m "Update description"
git push

Docfiy automatically deploys your changes. View your deployment status on the Overview page of your dashboard.

Next steps

Related topics

Ask agentWhat is Docfiy?Introduction