Skip to content

Commit 2d1cccf

Browse files
committed
chore: current progress
1 parent dd0be9c commit 2d1cccf

11 files changed

+146
-334
lines changed

docs/api/overview.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: overview
3+
title: API Documentation
4+
sidebar_label: Overview
5+
---
6+
7+
# API Page
8+
9+
ello

docs/fakeapi/api/get-post-by-id.api.mdx

-71
This file was deleted.

docs/fakeapi/api/get-posts.api.mdx

-63
This file was deleted.

docs/fakeapi/api/sidebar.ts

-30
This file was deleted.

docs/fakeapi/api/test-api.info.mdx

-35
This file was deleted.

docusaurus.config.js

+13-28
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
import { themes as prismThemes } from 'prism-react-renderer';
88
import 'dotenv/config';
9+
// const { apiSidebar } = require('./sidebar-api');
910

1011
/** @type {import('@docusaurus/types').Config} */
1112
const config = {
@@ -128,12 +129,12 @@ const config = {
128129
docId: 'quickstart',
129130
label: 'Build',
130131
},
131-
// {
132-
// type: 'doc',
133-
// position: 'left',
134-
// docId: 'community-and-support',
135-
// label: 'API',
136-
// },
132+
{
133+
type: 'doc',
134+
position: 'left',
135+
docId: 'api/overview',
136+
label: 'API',
137+
},
137138
{
138139
type: 'doc',
139140
position: 'left',
@@ -250,31 +251,15 @@ const config = {
250251
outputDir: 'docs/nildb/api',
251252
sidebarOptions: { groupPathsBy: 'tag' },
252253
},
253-
testAPI: {
254-
specPath: 'apispec/test.yaml',
255-
outputDir: 'docs/fakeapi/api',
256-
sidebarOptions: { groupPathsBy: 'tag' },
257-
},
254+
// Placeholder: for future APIs
255+
// testAPI: {
256+
// specPath: 'apispec/test.yaml',
257+
// outputDir: 'docs/fakeapi/api',
258+
// sidebarOptions: { groupPathsBy: 'tag' },
259+
// },
258260
},
259261
},
260262
],
261-
// [
262-
// 'docusaurus-plugin-openapi-docs',
263-
// {
264-
// id: 'api',
265-
// docsPluginId: 'classic',
266-
// config: {
267-
// nildbapi: {
268-
// specPath: 'apispec/nildb-two.yaml',
269-
// outputDir: 'docs/nildb/api',
270-
// sidebarOptions: {
271-
// groupPathsBy: 'tag',
272-
// },
273-
// },
274-
// // You can add more API specs here
275-
// },
276-
// },
277-
// ],
278263
],
279264
};
280265

sidebar-api.js

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
module.exports = [
2+
{
3+
type: 'html',
4+
className: 'sidebar-title',
5+
value: 'API',
6+
defaultStyle: true,
7+
},
8+
'api/overview',
9+
{
10+
type: 'category',
11+
label: 'NilDB API',
12+
items: [
13+
'nildb/api/get-health-status',
14+
'nildb/api/get-node-details',
15+
'nildb/api/list-the-organizations-queries',
16+
'nildb/api/list-the-organizations-schemas',
17+
'nildb/api/delete-data-records-that-match-a-given-filter',
18+
'nildb/api/execute-the-specified-query',
19+
'nildb/api/remove-all-documents-in-a-schema-collection',
20+
'nildb/api/retrieve-an-organizations-account-details',
21+
'nildb/api/retrieve-an-organizations-account-details',
22+
'nildb/api/retrieve-data-from-the-specified-schema-collection-that-matches-the-provided-filter',
23+
'nildb/api/retrieve-recently-added-documents-from-a-schema-collection',
24+
'nildb/api/update-documents-within-a-schema-collection-that-match-the-given-filter',
25+
'nildb/api/upload-data-to-the-specified-schema-collection',
26+
],
27+
},
28+
];

sidebar-build.js

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
const buildSidebar = [
2+
{
3+
type: 'html',
4+
className: 'sidebar-title',
5+
value: 'Build',
6+
defaultStyle: true,
7+
},
8+
'quickstart',
9+
{
10+
type: 'category',
11+
label: 'SecretVault & SecretDataAnalytics',
12+
items: [
13+
{
14+
type: 'doc',
15+
label: 'Overview',
16+
id: 'build/secretVault-secretDataAnalytics/overview',
17+
},
18+
'build/secretVault-secretDataAnalytics/generate-tokens',
19+
'build/secretVault-secretDataAnalytics/encryption',
20+
'build/secretVault-secretDataAnalytics/upload-retrieve',
21+
{
22+
type: 'link',
23+
label: 'API Reference',
24+
href: 'https://nildb-a50d.nillion.network/api/v1/openapi/docs/',
25+
},
26+
{
27+
type: 'link',
28+
label: 'Examples',
29+
href: 'https://github.com/NillionNetwork/blind-module-examples/tree/main/nildb',
30+
},
31+
],
32+
},
33+
{
34+
type: 'category',
35+
label: 'SecretLLM',
36+
link: {
37+
type: 'doc',
38+
id: 'build/secretLlm/overview',
39+
},
40+
items: [],
41+
},
42+
{
43+
type: 'category',
44+
label: 'SecretSigning',
45+
link: {
46+
type: 'doc',
47+
id: 'build/secretSigning/overview',
48+
},
49+
items: [],
50+
},
51+
'build/blind-modules',
52+
];
53+
54+
module.exports = {
55+
buildSidebar,
56+
};

sidebar-community.js

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
const communitySidebar = [
2+
{
3+
type: 'html',
4+
className: 'sidebar-title',
5+
value: 'Community',
6+
defaultStyle: true,
7+
},
8+
'community-and-support',
9+
{
10+
type: 'category',
11+
label: 'Testnet Guides',
12+
link: {
13+
type: 'doc',
14+
id: 'testnet-guides',
15+
},
16+
items: [
17+
'guide-testnet-connect',
18+
'guide-testnet-faucet',
19+
'guide-testnet-tx',
20+
],
21+
},
22+
];
23+
24+
module.exports = {
25+
communitySidebar,
26+
};

0 commit comments

Comments
 (0)