Skip to content

Commit 6516ccc

Browse files
committed
Adding API documentation
1 parent 3dae42a commit 6516ccc

File tree

17 files changed

+5247
-25518
lines changed

17 files changed

+5247
-25518
lines changed

docs/api.js

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import React from "react";
2+
import Layout from "@theme/Layout";
3+
import "@stoplight/elements/styles.min.css";
4+
import { API } from "@stoplight/elements";
5+
import BrowserOnly from "@docusaurus/BrowserOnly";
6+
export default function Api() {
7+
return (
8+
<Layout title="API example">
9+
<BrowserOnly>
10+
{() => (
11+
<API
12+
apiDescriptionUrl="https://api.apis.guru/v2/specs/github.com/1.1.4/openapi.yaml"
13+
router="hash"
14+
/>
15+
)}
16+
</BrowserOnly>
17+
</Layout>
18+
);
19+
}

docs/introduction/1-Introduction.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ QAnswer is a platform that allows to combine the power of Large Language Models
4848
<ul style={{'list-style-type': 'disc'}}>
4949
<li>[**Web Widgets**](tutorial-ui/expose/classical-integrations/website-chatbot): Embed interactive chatbots seamlessly into your website or intranet pages.</li>
5050
<li>[**Integrations**](/tutorial-ui/expose/third-party-integrations/bubble): Leverage existing platforms like Microsoft Teams, Slack, or other collaboration tools.</li>
51-
<li>**Native APIs**: Develop custom integrations and workflows tailored to your specific requirements.</li>
51+
<li>[**Native APIs**](/api): Develop custom integrations and workflows tailored to your specific requirements.</li>
5252
</ul>
5353

5454
Potential Use Cases include:

docusaurus.config.js

+6-4
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const config = {
2626
defaultLocale: 'en',
2727
locales: ['en'],
2828
},
29-
29+
plugins: ['docusaurus-plugin-sass', 'docusaurus-node-polyfills'],
3030
presets: [
3131
[
3232
'classic',
@@ -37,7 +37,6 @@ const config = {
3737
routeBasePath: '/',
3838
},
3939
blog: false,
40-
pages: false,
4140
theme: {
4241
customCss: require.resolve('./src/css/custom.css'),
4342
},
@@ -58,14 +57,17 @@ const config = {
5857
maxHeadingLevel: 5,
5958
},
6059
navbar: {
61-
title: 'Docs',
60+
title: '',
6261
logo: {
6362
alt: 'The QA Company logo',
6463
src: 'img/logo2.png',
6564
href: 'https://qanswer.ai',
6665
target: '_self',
6766
},
68-
items: [],
67+
items: [
68+
{to: '/', label: 'Docs', position: 'left'},
69+
{to: '/api', label: 'APIs', position: 'left'},
70+
],
6971
},
7072
footer: {
7173
style: 'dark',

0 commit comments

Comments
 (0)