quivr/docs/mint.json
Stan Girard 15d43c492d
feat(docs): added homepage (#1919)
# Description

Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.

## Checklist before requesting a review

Please delete options that are not relevant.

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged

## Screenshots (if appropriate):
2023-12-25 09:02:49 +01:00

122 lines
2.7 KiB
JSON

{
"$schema": "https://mintlify.com/schema.json",
"name": "Quivr",
"favicon": "/favicon.svg",
"colors": {
"primary": "#6142D4",
"light": "#F6F4FF",
"dark": "#13ABBA",
"anchors": {
"from": "#6142D4",
"to": "#F6F4FF"
}
},
"topbarLinks": [
{
"name": "Support",
"url": "mailto:stan@quivr.app"
}
],
"topbarCtaButton": {
"name": "Try Quivr",
"url": "https://quivr.app"
},
"tabs": [
{
"name": "Developer Guide",
"url": "developers"
}
],
"anchors": [
{
"name": "Documentation",
"icon": "book-open-cover",
"url": "https://docs.quivr.app"
},
{
"name": "Community",
"icon": "discord",
"url": "https://discord.gg/HUpRgp2HG8"
},
{
"name": "Blog",
"icon": "newspaper",
"url": "https://quivr.app/blog"
}
],
"navigation": [
{
"group": "Getting Started",
"pages": [
"intro"
]
},
{
"group": "Power-user",
"pages": [
"userGuide/what-is-a-brain",
"userGuide/api-based-brains"
]
},
{
"group": "Contribute",
"pages": [
"developers/contribution/guidelines",
"developers/contribution/architecture",
"developers/contribution/install",
"developers/contribution/test",
{
"group": "Chains",
"pages": [
"developers/contribution/chains/qa"
]
},
{
"group": "LLM",
"pages": [
"developers/contribution/llm/private-llm"
]
}
]
},
{
"group": "Self Hosting",
"pages": [
"developers/selfHosting/run_fully_local",
"developers/selfHosting/vps_install",
"developers/selfHosting/authentication"
]
},
{
"group": "Integrating",
"pages": [
"developers/useQuivr/getting_started",
"developers/useQuivr/get_your_api_key",
"developers/useQuivr/error_handling",
"developers/useQuivr/chat",
{
"group": "Brains",
"pages": [
"developers/useQuivr/brain/create_a_brain",
"developers/useQuivr/brain/retrieve_brain_attributes",
"developers/useQuivr/brain/set_default_brain",
"developers/useQuivr/brain/update_a_brain"
]
}
]
}
],
"footerSocials": {
"twitter": "https://twitter.com/quivr_brain",
"github": "https://github.com/stangirard/quivr",
"linkedin": "https://www.linkedin.com/company/getquivr",
"discord": "https://discord.gg/HUpRgp2HG8"
},
"openapi": "https://api.quivr.app/openapi.json",
"feedback": {
"thumbsRating": true,
"raiseIssue": true,
"suggestEdit": true
}
}