Skip to content

Commit f4a99b0

Browse files
authored
Add LLM features, change theme and footer links (#266)
1 parent 203595a commit f4a99b0

File tree

6 files changed

+1149
-336
lines changed

6 files changed

+1149
-336
lines changed

docs.json

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "https://mintlify.com/docs.json",
3-
"theme": "mint",
3+
"theme": "maple",
44
"name": "Axiom Docs",
55
"description": "Axiom’s official documentation site. Learn everything about how to use Axiom.",
66
"colors": {
@@ -263,6 +263,14 @@
263263
},
264264
"reference/security"
265265
]
266+
},
267+
{
268+
"group": "LLMs",
269+
"pages": [
270+
"llms/llms-overview",
271+
"llms/llms",
272+
"llms/llms-full"
273+
]
266274
}
267275
]
268276
},
@@ -650,15 +658,30 @@
650658
}
651659
},
652660
"seo": {
653-
"indexing": "navigable"
661+
"indexing": "navigable",
662+
"metatags": {
663+
"og:site_name": "Axiom",
664+
"og:title": "Axiom Docs",
665+
"og:description": "Axiom’s official documentation site. Learn everything about how to use Axiom."
666+
}
654667
},
655668
"footer": {
656669
"socials": {
657-
"twitter": "https://twitter.com/AxiomFM",
670+
"x": "https://x.com/AxiomFM",
658671
"github": "https://github.com/axiomhq",
659-
"linkedin": "https://linkedin.com/company/axiomhq"
672+
"linkedin": "https://linkedin.com/company/axiomhq",
673+
"discord": "https://axiom.co/discord"
660674
}
661675
},
676+
"contextual": {
677+
"options": [
678+
"copy",
679+
"view"
680+
]
681+
},
682+
"styling": {
683+
"eyebrows": "breadcrumbs"
684+
},
662685
"integrations": {
663686
"fathom": {
664687
"siteId": "BGVZPGXQ"

llms/llms-full.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Full docs
3+
url: "https://axiom.co/docs/llms-full.txt"
4+
icon: robot
5+
---
6+
7+
Access the [full documentation](https://axiom.co/docs/llms-full.txt) in Markdown format and pass it to your LLM.

llms/llms-overview.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Interpret Axiom docs with LLMs
3+
description: "This page explains how to interpret Axiom docs with LLMs."
4+
sidebarTitle: Overview
5+
icon: microchip-ai
6+
---
7+
8+
## AI chat
9+
10+
To get an answer about Axiom from the documentation’s built-in AI assistant, press <kbd>Cmd/Ctrl</kbd>&nbsp;<kbd>K</kbd>, and then type your question.
11+
12+
## Interpret individual pages
13+
14+
To interpret individual pages of the documentation with an LLM, click <Icon icon="chevron-down" iconType="solid" /> in the top right, and then choose one of the following options:
15+
- Copy the page in Markdown format and manually pass it to LLMs
16+
- View the page in Markdown format and manually pass its URL to LLMs
17+
18+
## Interpret the full docs
19+
20+
To make it easy for LLMs to interpret the documentation, Axiom offers the following based on the [/llms.txt standard](https://llmstxt.org/):
21+
22+
- [List of docs pages](https://axiom.co/docs/llms.txt)
23+
- [Full documentation](https://axiom.co/docs/llms-full.txt)
24+
25+
Access one of the above documents and pass it to your LLM to start interpreting the Axiom documentation.

llms/llms.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: List of docs pages
3+
url: "https://axiom.co/docs/llms.txt"
4+
icon: list
5+
---
6+
7+
Access the [list of docs pages](https://axiom.co/docs/llms.txt) in Markdown format and pass it to your LLM.

0 commit comments

Comments
 (0)