Giter Club home page Giter Club logo

danswer-docs's Introduction

Danswer Docs

This repo generates the docs and setup guide for Danswer found at https://docs.danswer.dev/.

It uses Mintlify which is a no-code documentation generation tool. Instructions on setting up local preview are included below.

More info on Mintlify found here.

To make changes, check out mint.json, it should be fairly straightforward hopefully!

Set up Mintlify

Install the Mintlify CLI to preview the documentation changes locally.

To install, use the following command (requires node >= v19.0.0)

npm i -g mintlify

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

mintlify dev

Publishing Changes

Changes are automatically deployed to production after merging to main.

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
  • Mintlify Docs - https://mintlify.com/docs/introduction

danswer-docs's People

Contributors

yuhongsun96 avatar weves avatar jainpawan21 avatar alex000kim avatar ssddanbrown avatar doprdele avatar useruid avatar hagen6835 avatar itayb avatar swiknaba avatar pkabra avatar rutik7066 avatar nlp8899 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.