feat: Remove all TBD and TODOs from V2 docs

* feat: Remove all TBD and TODOs from V2 docs * fix: Remove broken links Approved-by: Patryk Ziemkowski
apptension · May 25, 2023 · 92fce4a · 92fce4a
1 parent 076b2bf
commit 92fce4a
Show file tree

Hide file tree

Showing 33 changed files with 23 additions and 278 deletions.
diff --git a/packages/internal/docs/docs/v2/api-reference/env-files.mdx b/packages/internal/docs/docs/v2/api-reference/env-files.mdx
@@ -5,13 +5,6 @@ description: Description of the .env files
 
 Below you can find a list of different `.env` files used in the project along with description of it's content.
 
-:::info
-
-Find more about using `.env` files in the [`How to work with .env files?`](../working-with-sb/project-structure/env-files)
-guide.
-
-:::
-
 ### Common values used in `.env`, `.env.shared` and `.env.{env-id}` files:
 
 :::info

diff --git a/packages/internal/docs/docs/v2/api-reference/env.mdx b/packages/internal/docs/docs/v2/api-reference/env.mdx
@@ -8,9 +8,6 @@ Below you can find a comprehensive list of environment variables used in particu
 If you would like to find how to set correct environment on **_AWS_** check this
 [guide](../aws/deploy-to-aws/create-runtime-env-vars).
 
-If you would like to find how to set correct environment on your **_local machine_** using `.env` files check this
-[guide](../working-with-sb/project-structure/env-files).
-
 ### `backend` service
 
 import BackendEnvVars from '../shared/partials/env-vars/_backend.mdx';

diff --git a/packages/internal/docs/docs/v2/aws/deploy-to-aws/create-env-stage-in-repo.mdx b/packages/internal/docs/docs/v2/aws/deploy-to-aws/create-env-stage-in-repo.mdx
@@ -28,10 +28,3 @@ cp .env.stage-example .env.qa
 
 Follow the [API reference of the `.env`](../../api-reference/env-files) files for the details of the contents of the
 environment stage dotenv file.
-
-:::info
-
-To learn more about using `.env` files in <ProjectName/> read the
-[`How to work with .env files?`](../../working-with-sb/project-structure/env-files) article.
-
-:::
diff --git a/packages/internal/docs/docs/v2/index.mdx b/packages/internal/docs/docs/v2/index.mdx
@@ -14,8 +14,6 @@ Our documentation is organized into five main sections:
 
 - [Getting started](/v2/getting-started): This section contains instructions on how to set up and run a new project based on the <ProjectName/>, as well as how to run an existing instance of it.
 
-- [Tutorials](/tutorials): Our tutorials section contains step-by-step guides on how to build different features using base code of the <ProjectName/>.
-
 - [Working with <ProjectName/>](/working-with-sb): This section provides a detailed description of what's under the hood of the <ProjectName/>'s features and best practices.
 
 - [What is <ProjectName/>](/v2/introduction): This section provides a high-level overview of the <ProjectName/> project and its architecture.

diff --git a/...ges/internal/docs/docs/v2/introduction/coding-standards/formatters/prettier.mdx b/...ges/internal/docs/docs/v2/introduction/coding-standards/formatters/prettier.mdx
diff --git a/packages/internal/docs/docs/v2/introduction/coding-standards/linters/eslint.mdx b/packages/internal/docs/docs/v2/introduction/coding-standards/linters/eslint.mdx
diff --git a/packages/internal/docs/docs/v2/introduction/development.mdx b/packages/internal/docs/docs/v2/introduction/development.mdx
diff --git a/packages/internal/docs/docs/v2/introduction/features/assets.mdx b/packages/internal/docs/docs/v2/introduction/features/assets.mdx
@@ -31,10 +31,13 @@ different sizes on your website.
 
 ----
 
-:::info
+[//]: # (:::info)
 
-If you would like to learn more about the technical aspects of the assets management in SaaS Boilerplate, or if you need
-to adjust it to meet the specific needs of your application, please refer to our
-[Assets management](../../../working-with-sb/asset-management) guides for detailed information.
+[//]: # ()
+[//]: # (If you would like to learn more about the technical aspects of the assets management in SaaS Boilerplate, or if you need)
 
-:::
+[//]: # (to adjust it to meet the specific needs of your application, please refer to our)
+
+[//]: # ([Assets management]&#40;../../../working-with-sb/asset-management&#41; guides for detailed information.)
+
+[//]: # (:::)
diff --git a/packages/internal/docs/docs/v2/introduction/features/index.mdx b/packages/internal/docs/docs/v2/introduction/features/index.mdx
@@ -4,6 +4,4 @@ title: SaaS Boilerplate features
 
 import DocCardList from '@theme/DocCardList';
 
-Desc: TBD
-
 <DocCardList />
diff --git a/packages/internal/docs/docs/v2/tutorials/crud.mdx b/packages/internal/docs/docs/v2/tutorials/crud.mdx
diff --git a/packages/internal/docs/docs/v2/tutorials/deploy-to-aws.mdx b/packages/internal/docs/docs/v2/tutorials/deploy-to-aws.mdx
diff --git a/packages/internal/docs/docs/v2/tutorials/deploy-to-production.mdx b/packages/internal/docs/docs/v2/tutorials/deploy-to-production.mdx
diff --git a/...es/internal/docs/docs/v2/working-with-sb/asset-management/create-signed-url.mdx b/...es/internal/docs/docs/v2/working-with-sb/asset-management/create-signed-url.mdx
diff --git a/packages/internal/docs/docs/v2/working-with-sb/asset-management/file-upload.mdx b/packages/internal/docs/docs/v2/working-with-sb/asset-management/file-upload.mdx
diff --git a/packages/internal/docs/docs/v2/working-with-sb/contentful/demo-item-model.mdx b/packages/internal/docs/docs/v2/working-with-sb/contentful/demo-item-model.mdx
diff --git a/packages/internal/docs/docs/v2/working-with-sb/dev-tools/mailcatcher.mdx b/packages/internal/docs/docs/v2/working-with-sb/dev-tools/mailcatcher.mdx
@@ -1,6 +1,5 @@
 ---
 title: Mailcatcher
-description: TODO >Description<
 ---
 import ProjectName from '../../shared/components/ProjectName.component';
 
@@ -15,10 +14,14 @@ all backend services. To access Mailcatcher, simply go to [`localhost:1080`](htt
 This will take you to the Mailcatcher web interface, where you can view all emails sent from your local environment.
 
 
-:::info
+[//]: # (:::info)
 
-Note that in order for Mailcatcher to work properly, your emails need to be pre-rendered.
-We have provided detailed instructions on how to do this in our documentation
-[here](/v2/working-with-sb/emails/build-emails).
+[//]: # ()
+[//]: # (Note that in order for Mailcatcher to work properly, your emails need to be pre-rendered.)
 
-:::
+[//]: # (We have provided detailed instructions on how to do this in our documentation)
+
+[//]: # ([here]&#40;/v2/working-with-sb/emails/build-emails&#41;.)
+
+[//]: # ()
+[//]: # (:::)
diff --git a/packages/internal/docs/docs/v2/working-with-sb/emails/build-emails.mdx b/packages/internal/docs/docs/v2/working-with-sb/emails/build-emails.mdx
diff --git a/...s/internal/docs/docs/v2/working-with-sb/graphql/backend/adding-new-mutation.mdx b/...s/internal/docs/docs/v2/working-with-sb/graphql/backend/adding-new-mutation.mdx
@@ -1,6 +1,5 @@
 ---
 title: How to add a new mutation to back-end API?
-description: TODO >Description<
 ---
 import ProjectName from '../../../shared/components/ProjectName.component';
 

diff --git a/...internal/docs/docs/v2/working-with-sb/graphql/conventions/nodes-connections.mdx b/...internal/docs/docs/v2/working-with-sb/graphql/conventions/nodes-connections.mdx
diff --git a/packages/internal/docs/docs/v2/working-with-sb/graphql/conventions/paging.mdx b/packages/internal/docs/docs/v2/working-with-sb/graphql/conventions/paging.mdx
diff --git a/.../internal/docs/docs/v2/working-with-sb/graphql/web-app/component-with-query.mdx b/.../internal/docs/docs/v2/working-with-sb/graphql/web-app/component-with-query.mdx
@@ -1,6 +1,5 @@
 ---
 title: How to write a React component that fetches data from back-end?
-description: TODO >Description<
 ---
 
 import ProjectName from '../../../shared/components/ProjectName.component';

diff --git a/...es/internal/docs/docs/v2/working-with-sb/graphql/web-app/naming-conventions.mdx b/...es/internal/docs/docs/v2/working-with-sb/graphql/web-app/naming-conventions.mdx
diff --git a/packages/internal/docs/docs/v2/working-with-sb/graphql/web-app/subscriptions.mdx b/packages/internal/docs/docs/v2/working-with-sb/graphql/web-app/subscriptions.mdx
diff --git a/packages/internal/docs/docs/v2/working-with-sb/guides/real-time-data.mdx b/packages/internal/docs/docs/v2/working-with-sb/guides/real-time-data.mdx
diff --git a/packages/internal/docs/docs/v2/working-with-sb/ide-editors/configure-pycharm.mdx b/packages/internal/docs/docs/v2/working-with-sb/ide-editors/configure-pycharm.mdx
diff --git a/packages/internal/docs/docs/v2/working-with-sb/ide-editors/configure-vscode.mdx b/packages/internal/docs/docs/v2/working-with-sb/ide-editors/configure-vscode.mdx
diff --git a/...ges/internal/docs/docs/v2/working-with-sb/payments/create-subscription-plan.mdx b/...ges/internal/docs/docs/v2/working-with-sb/payments/create-subscription-plan.mdx
diff --git a/packages/internal/docs/docs/v2/working-with-sb/payments/subscription-access.mdx b/packages/internal/docs/docs/v2/working-with-sb/payments/subscription-access.mdx
diff --git a/...s/internal/docs/docs/v2/working-with-sb/project-structure/create-nx-command.mdx b/...s/internal/docs/docs/v2/working-with-sb/project-structure/create-nx-command.mdx
diff --git a/packages/internal/docs/docs/v2/working-with-sb/project-structure/env-files.mdx b/packages/internal/docs/docs/v2/working-with-sb/project-structure/env-files.mdx
diff --git a/...ages/internal/docs/docs/v2/working-with-sb/project-structure/remove-web-lib.mdx b/...ages/internal/docs/docs/v2/working-with-sb/project-structure/remove-web-lib.mdx
diff --git a/packages/internal/docs/docs/v2/working-with-sb/tests/e2e.mdx b/packages/internal/docs/docs/v2/working-with-sb/tests/e2e.mdx
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,13 +5,6 @@ description: Description of the .env files @@
     Below you can find a list of different `.env` files used in the project along with description of it's content.
-    :::info
-    Find more about using `.env` files in the [`How to work with .env files?`](../working-with-sb/project-structure/env-files)
-    guide.
-    :::
     ### Common values used in `.env`, `.env.shared` and `.env.{env-id}` files:
     :::info
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,6 +4,4 @@ title: SaaS Boilerplate features

		import DocCardList from '@theme/DocCardList';

		Desc: TBD

		<DocCardList />