Skip to content

feat: update docs #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
43 changes: 32 additions & 11 deletions docs/config/api.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
export default [
'/api',
{
title: 'HTTP API',
type: 'subMenu',
children: ['/api/http', '/api/http/rest-api'],
},
// {
// title: 'HTTP API',
// type: 'subMenu',
// children: ['/api/http', '/api/http/rest-api'],
// },
{
title: '@nocobase/acl',
type: 'subMenu',
children: ['/api/acl/acl', '/api/acl/acl-role', '/api/acl/acl-resource'],
link: '/api/acl/acl',
// type: 'subMenu',
// children: ['/api/acl/acl', '/api/acl/acl-role', '/api/acl/acl-resource'],
},
{
title: '@nocobase/actions',
Expand Down Expand Up @@ -52,6 +53,18 @@ export default [
'/api/database/operators',
],
},
{
title: '@nocobase/data-source-manager',
type: 'subMenu',
children: [
'/api/data-source-manager',
'/api/data-source-manager/data-source',
'/api/data-source-manager/i-collection-manager',
'/api/data-source-manager/i-collection',
'/api/data-source-manager/i-repository',
'/api/data-source-manager/i-model',
],
},
{
title: '@nocobase/logger',
link: '/api/logger',
Expand All @@ -61,14 +74,18 @@ export default [
type: 'subMenu',
children: [
'/api/resourcer',
'/api/resourcer/resource',
// '/api/resourcer/resource',
'/api/resourcer/action',
'/api/resourcer/middleware',
// '/api/resourcer/middleware',
],
},
{
title: '@nocobase/sdk',
link: '/api/sdk',
children: [
'/api/sdk',
'/api/sdk/auth',
'/api/sdk/storage',
]
},
{
title: '@nocobase/server',
Expand All @@ -91,6 +108,10 @@ export default [
{
title: '@nocobase/test',
type: 'subMenu',
children: ['/api/test/e2e'],
children: [
'/api/test/server',
'/api/test/client',
'/api/test/e2e',
],
},
]
46 changes: 28 additions & 18 deletions docs/config/development.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export default [
'/development',
'/development/your-fisrt-plugin',
'/development/app-ds',
'/development/pm',
// '/development/plugin-ds',
// '/development/learning-guide',
],
Expand All @@ -17,37 +18,46 @@ export default [
type: 'group',
children: [
'/development/server',
'/development/server/data-source',
{
title: 'Collections & Fields',
'title.zh-CN': '数据表和字段',
children: [
'/development/server/collections',
'/development/server/collections/options',
'/development/server/collections/configure',
'/development/server/collections/association-fields',
'/development/server/collections/field-extension',
'/development/server/collections/field-type',
'/development/server/collections/field-interface',
'/development/server/collections/collection-template',
// '/development/server/collections/options',
'/development/server/collections/plugin-collections',
// '/development/server/collections/association-fields',
// '/development/server/collections/field-extension',
// '/development/server/collections/collection-template',
],
},
// {
// title: 'Resources & Actions',
// 'title.zh-CN': '资源和操作',
// children: [
// '/development/server/resources-actions',
// '/development/server/resources-actions/configuration',
// // '/development/server/resources-actions/to-resource',
// '/development/server/resources-actions/vs-router',
// ],
// },
'/development/server/resources-actions',
// '/development/server/routing',
{
title: 'Resources & Actions',
'title.zh-CN': '资源和操作',
children: [
'/development/server/resources-actions-v2',
// '/development/server/resources-actions-v2/request',
'/development/server/resources-actions-v2/resource-manager',
// '/development/server/resources-actions/configuration',
// '/development/server/resources-actions/to-resource',
// '/development/server/resources-actions/vs-router',
],
},
// '/development/server/resources-actions',
'/development/server/context',
'/development/server/middleware',
'/development/server/commands',
'/development/server/routing',
'/development/server/acl',
'/development/server/events',
'/development/server/caching',
'/development/server/migration',
'/development/server/commands',
'/development/server/i18n',
'/development/server/logger',
'/development/server/telemetry',
'/development/server/migration',
'/development/server/test',
],
},
Expand Down
Loading