Skyvern/docs
2024-06-18 01:53:18 -04:00
..
api-reference Introduce docs (#5) 2024-03-02 00:44:02 -05:00
essentials Introduce docs (#5) 2024-03-02 00:44:02 -05:00
getting-started Add task and workflow docs (#486) 2024-06-18 01:53:18 -04:00
images Add task and workflow docs (#486) 2024-06-18 01:53:18 -04:00
integrations Add task and workflow docs (#486) 2024-06-18 01:53:18 -04:00
logo Introduce docs (#5) 2024-03-02 00:44:02 -05:00
running-tasks Add task and workflow docs (#486) 2024-06-18 01:53:18 -04:00
snippets Introduce docs (#5) 2024-03-02 00:44:02 -05:00
workflows Add task and workflow docs (#486) 2024-06-18 01:53:18 -04:00
development.mdx Introduce docs (#5) 2024-03-02 00:44:02 -05:00
favicon.svg Introduce docs (#5) 2024-03-02 00:44:02 -05:00
introduction.mdx Documentation updates -- add introduction + Skyvern in action page (#477) 2024-06-16 02:10:29 -04:00
mint.json Add task and workflow docs (#486) 2024-06-18 01:53:18 -04:00
quickstart.mdx docs: update quickstart.mdx (#284) 2024-05-08 19:10:29 -04:00
README.md Remove doctoc exclude, skip main README only (#169) 2024-04-08 17:14:44 -07:00

Table of Contents generated with DocToc

Mintlify Starter Kit

Click on Use this template to copy the Mintlify starter kit. The starter kit contains examples including

  • Guide pages
  • Navigation
  • Customizations
  • API Reference pages
  • Use of popular components

Development

Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command

npm i -g mintlify

Run the following command at the root of your documentation (where mint.json is)

mintlify dev

Publishing Changes

Install our Github App to autopropagate changes from youre repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.

Troubleshooting

  • Mintlify dev isn't running - Run mintlify install it'll re-install dependencies.
  • Page loads as a 404 - Make sure you are running in a folder with mint.json