diff --git a/quickstart.mdx b/quickstart.mdx index 076ea0a24..235c34077 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -76,21 +76,7 @@ Install the GitHub App by following the instructions from the onboarding checkli An admin for your GitHub organization may need to authorize your account depending on your organization settings. -## Editing workflows - -Mintlify offers two workflows for creating and maintaining your documentation: - - - For users who prefer working with existing tools in their local environment. Click to jump to this section. - - - - For users who prefer a visual interface in their web browser. Click to jump to this section. - - -## Code-based workflow - -The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code. +## Make your first edit ### Install the CLI @@ -172,75 +158,6 @@ Mintlify automatically detects the changes, builds your documentation, and deplo After the deployment completes, your latest update will be available at `.mintlify.app`. - - Optionally, skip the web editor workflow and jump to adding a custom domain. - - -## Web editor workflow - -The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. This workflow is best for people who want to work in their web browser without additional local development tools. - -### Access the web editor - -1. Log in to your [dashboard](https://dashboard.mintlify.com). -2. Select **Editor** on the left sidebar. - - - If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor. - - - - The Mintlify web editor in the visual editor mode - - The Mintlify web editor in the visual editor mode - - -### Edit the documentation - -In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page: - -Find and select `index.mdx` in the file explorer. - -Then, in the editor, update the title field to "Hello World". - - - Editing in Web Editor - - Editing in Web Editor - - - - The editor provides a rich set of formatting tools and components. Type / - - in the editor to open the command menu and access these tools. - - -### Publish your changes - -When you're satisfied with your edits, select the **Publish** button in the top-right corner. Your changes are immediately deployed to your documentation site. - - - Use branches to preview and review changes through pull requests before deploying to your live site. - - -For more details about using the web editor, including using branches and pull requests to collaborate and preview changes, see our [web editor documentation](/editor). - ## Adding a custom domain While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation. @@ -306,7 +223,7 @@ If you encounter issues during the setup process, check these common troubleshoo Make sure you have Node.js v19+ installed and that you run the `mint dev` command from the directory containing your `docs.json` file. - Deployment can take up to a few minutes. Check your GitHub Actions (for code-based workflow) or deployment logs in the Mintlify dashboard to ensure there are no build errors. + Deployment can take up to a few minutes. Check your GitHub Actions or deployment logs in the Mintlify dashboard to ensure there are no build errors. Verify that your DNS records are set up correctly and allow sufficient time for DNS propagation (up to 48 hours). You can use tools like [DNSChecker](https://dnschecker.org) to verify your CNAME record.