From 495036b617a9bee608c5f924f1265a9f2e7793ee Mon Sep 17 00:00:00 2001 From: Naveen MR Date: Tue, 7 Sep 2021 12:22:08 +0100 Subject: [PATCH] docs : refactor Signed-off-by: Naveen MR --- packages/nc-cli/README.md | 1 - packages/noco-blog/README.md | 11 +---------- packages/noco-book/README.md | 12 +----------- packages/noco-docs/README.md | 10 +--------- .../{AccessingAPIs.md => accessing-apis.md} | 0 .../{GraphqlAPIs.md => graphql-apis.md} | 0 .../{RestAPIs.md => rest-apis.md} | 0 .../developer-resources/{Webhooks.md => webhooks.md} | 0 .../en/getting-started/{Demos.md => demos.md} | 0 .../{Installation.md => installation.md} | 0 .../getting-started/{Upgrading.md => upgrading.md} | 0 .../en/setup-and-usages/{Audit.md => audit.md} | 0 .../{ColumnTypes.md => column-types.md} | 0 .../setup-and-usages/{Dashboard.md => dashboard.md} | 0 .../en/setup-and-usages/{Formulas.md => formulas.md} | 2 +- .../en/setup-and-usages/link-to-another-record.md | 9 +++++++++ .../noco-docs/content/en/setup-and-usages/lookup.md | 10 ++++++++++ .../{MetaManagement.md => meta-management.md} | 0 .../noco-docs/content/en/setup-and-usages/rollup.md | 10 ++++++++++ .../en/setup-and-usages/{Tables.md => tables.md} | 0 20 files changed, 33 insertions(+), 32 deletions(-) rename packages/noco-docs/content/en/developer-resources/{AccessingAPIs.md => accessing-apis.md} (100%) rename packages/noco-docs/content/en/developer-resources/{GraphqlAPIs.md => graphql-apis.md} (100%) rename packages/noco-docs/content/en/developer-resources/{RestAPIs.md => rest-apis.md} (100%) rename packages/noco-docs/content/en/developer-resources/{Webhooks.md => webhooks.md} (100%) rename packages/noco-docs/content/en/getting-started/{Demos.md => demos.md} (100%) rename packages/noco-docs/content/en/getting-started/{Installation.md => installation.md} (100%) rename packages/noco-docs/content/en/getting-started/{Upgrading.md => upgrading.md} (100%) rename packages/noco-docs/content/en/setup-and-usages/{Audit.md => audit.md} (100%) rename packages/noco-docs/content/en/setup-and-usages/{ColumnTypes.md => column-types.md} (100%) rename packages/noco-docs/content/en/setup-and-usages/{Dashboard.md => dashboard.md} (100%) rename packages/noco-docs/content/en/setup-and-usages/{Formulas.md => formulas.md} (99%) create mode 100644 packages/noco-docs/content/en/setup-and-usages/link-to-another-record.md create mode 100644 packages/noco-docs/content/en/setup-and-usages/lookup.md rename packages/noco-docs/content/en/setup-and-usages/{MetaManagement.md => meta-management.md} (100%) create mode 100644 packages/noco-docs/content/en/setup-and-usages/rollup.md rename packages/noco-docs/content/en/setup-and-usages/{Tables.md => tables.md} (100%) diff --git a/packages/nc-cli/README.md b/packages/nc-cli/README.md index 9d7aee2eb9..7b2b4fe9e0 100644 --- a/packages/nc-cli/README.md +++ b/packages/nc-cli/README.md @@ -1,3 +1,2 @@ # nc-cli -xc-cli diff --git a/packages/noco-blog/README.md b/packages/noco-blog/README.md index b6473757a6..14e0683530 100644 --- a/packages/noco-blog/README.md +++ b/packages/noco-blog/README.md @@ -1,11 +1,2 @@ -# `noco-doc` +# `noco-blog` -> TODO: description - -## Usage - -``` -const nocoDoc = require('noco-doc'); - -// TODO: DEMONSTRATE API -``` diff --git a/packages/noco-book/README.md b/packages/noco-book/README.md index b6473757a6..ee48b211de 100644 --- a/packages/noco-book/README.md +++ b/packages/noco-book/README.md @@ -1,11 +1 @@ -# `noco-doc` - -> TODO: description - -## Usage - -``` -const nocoDoc = require('noco-doc'); - -// TODO: DEMONSTRATE API -``` +# `noco-book` diff --git a/packages/noco-docs/README.md b/packages/noco-docs/README.md index b6473757a6..66e900009c 100644 --- a/packages/noco-docs/README.md +++ b/packages/noco-docs/README.md @@ -1,11 +1,3 @@ -# `noco-doc` +# `noco-docs` -> TODO: description -## Usage - -``` -const nocoDoc = require('noco-doc'); - -// TODO: DEMONSTRATE API -``` diff --git a/packages/noco-docs/content/en/developer-resources/AccessingAPIs.md b/packages/noco-docs/content/en/developer-resources/accessing-apis.md similarity index 100% rename from packages/noco-docs/content/en/developer-resources/AccessingAPIs.md rename to packages/noco-docs/content/en/developer-resources/accessing-apis.md diff --git a/packages/noco-docs/content/en/developer-resources/GraphqlAPIs.md b/packages/noco-docs/content/en/developer-resources/graphql-apis.md similarity index 100% rename from packages/noco-docs/content/en/developer-resources/GraphqlAPIs.md rename to packages/noco-docs/content/en/developer-resources/graphql-apis.md diff --git a/packages/noco-docs/content/en/developer-resources/RestAPIs.md b/packages/noco-docs/content/en/developer-resources/rest-apis.md similarity index 100% rename from packages/noco-docs/content/en/developer-resources/RestAPIs.md rename to packages/noco-docs/content/en/developer-resources/rest-apis.md diff --git a/packages/noco-docs/content/en/developer-resources/Webhooks.md b/packages/noco-docs/content/en/developer-resources/webhooks.md similarity index 100% rename from packages/noco-docs/content/en/developer-resources/Webhooks.md rename to packages/noco-docs/content/en/developer-resources/webhooks.md diff --git a/packages/noco-docs/content/en/getting-started/Demos.md b/packages/noco-docs/content/en/getting-started/demos.md similarity index 100% rename from packages/noco-docs/content/en/getting-started/Demos.md rename to packages/noco-docs/content/en/getting-started/demos.md diff --git a/packages/noco-docs/content/en/getting-started/Installation.md b/packages/noco-docs/content/en/getting-started/installation.md similarity index 100% rename from packages/noco-docs/content/en/getting-started/Installation.md rename to packages/noco-docs/content/en/getting-started/installation.md diff --git a/packages/noco-docs/content/en/getting-started/Upgrading.md b/packages/noco-docs/content/en/getting-started/upgrading.md similarity index 100% rename from packages/noco-docs/content/en/getting-started/Upgrading.md rename to packages/noco-docs/content/en/getting-started/upgrading.md diff --git a/packages/noco-docs/content/en/setup-and-usages/Audit.md b/packages/noco-docs/content/en/setup-and-usages/audit.md similarity index 100% rename from packages/noco-docs/content/en/setup-and-usages/Audit.md rename to packages/noco-docs/content/en/setup-and-usages/audit.md diff --git a/packages/noco-docs/content/en/setup-and-usages/ColumnTypes.md b/packages/noco-docs/content/en/setup-and-usages/column-types.md similarity index 100% rename from packages/noco-docs/content/en/setup-and-usages/ColumnTypes.md rename to packages/noco-docs/content/en/setup-and-usages/column-types.md diff --git a/packages/noco-docs/content/en/setup-and-usages/Dashboard.md b/packages/noco-docs/content/en/setup-and-usages/dashboard.md similarity index 100% rename from packages/noco-docs/content/en/setup-and-usages/Dashboard.md rename to packages/noco-docs/content/en/setup-and-usages/dashboard.md diff --git a/packages/noco-docs/content/en/setup-and-usages/Formulas.md b/packages/noco-docs/content/en/setup-and-usages/formulas.md similarity index 99% rename from packages/noco-docs/content/en/setup-and-usages/Formulas.md rename to packages/noco-docs/content/en/setup-and-usages/formulas.md index 4773233464..b8dafa5aef 100644 --- a/packages/noco-docs/content/en/setup-and-usages/Formulas.md +++ b/packages/noco-docs/content/en/setup-and-usages/formulas.md @@ -1,7 +1,7 @@ --- title: 'Formulas' description: 'Formulas' -position: 40 +position: 43 category: 'Usage' menuTitle: 'Formulas' --- diff --git a/packages/noco-docs/content/en/setup-and-usages/link-to-another-record.md b/packages/noco-docs/content/en/setup-and-usages/link-to-another-record.md new file mode 100644 index 0000000000..6b731a2424 --- /dev/null +++ b/packages/noco-docs/content/en/setup-and-usages/link-to-another-record.md @@ -0,0 +1,9 @@ +--- +title: 'Link To Another Record' +description: 'Link To Another Record' +position: 39 +category: 'Usage' +menuTitle: 'Link To Another Record' +--- + +> Todo \ No newline at end of file diff --git a/packages/noco-docs/content/en/setup-and-usages/lookup.md b/packages/noco-docs/content/en/setup-and-usages/lookup.md new file mode 100644 index 0000000000..8f4869315a --- /dev/null +++ b/packages/noco-docs/content/en/setup-and-usages/lookup.md @@ -0,0 +1,10 @@ +--- +title: 'Lookup' +description: 'Lookup' +position: 41 +category: 'Usage' +menuTitle: 'Lookup' +--- + + +> Todo \ No newline at end of file diff --git a/packages/noco-docs/content/en/setup-and-usages/MetaManagement.md b/packages/noco-docs/content/en/setup-and-usages/meta-management.md similarity index 100% rename from packages/noco-docs/content/en/setup-and-usages/MetaManagement.md rename to packages/noco-docs/content/en/setup-and-usages/meta-management.md diff --git a/packages/noco-docs/content/en/setup-and-usages/rollup.md b/packages/noco-docs/content/en/setup-and-usages/rollup.md new file mode 100644 index 0000000000..5e14314475 --- /dev/null +++ b/packages/noco-docs/content/en/setup-and-usages/rollup.md @@ -0,0 +1,10 @@ +--- +title: 'Rollup' +description: 'Rollup' +position: 42 +category: 'Usage' +menuTitle: 'Rollup' +--- + + +> Todo \ No newline at end of file diff --git a/packages/noco-docs/content/en/setup-and-usages/Tables.md b/packages/noco-docs/content/en/setup-and-usages/tables.md similarity index 100% rename from packages/noco-docs/content/en/setup-and-usages/Tables.md rename to packages/noco-docs/content/en/setup-and-usages/tables.md