From 6aa8945936451b78b922e138f85a09d63db6fbae Mon Sep 17 00:00:00 2001 From: Josemaria Nriagu <49484425+josenriagu@users.noreply.github.com> Date: Tue, 18 Jun 2024 13:11:34 +0100 Subject: [PATCH] Docs: updates (#12) * chore(): update base readme * chore(): update intro and workspace structure * chore: update layout widget * chore(): update submodule and docusaurus config * chore(): update packages - update gitignore file * chore(): sdk docs auto update * chore(): update docs * chore(): update docs * chore(): update docs * chore(): update submodule * chore(): sdk docs auto update * chore(): update config * chore(): update config * chore(): fix cfg * chore(): update links * chore(): update config * chore(): hooks docs auto update * chore(): sdk docs auto update * chore(): update submodule * chore(): remove and update generated files * chore(): remove generated files * chore(): stop tracking generated docs * chore(): update cfg * chore(): update yarnrc * chore(): update yarn * chore(): update readme and env example * chore(): update cfg * chore(): update cfg * chore(): update * chore(): update cfg * chore(): update hooks entry points --------- Co-authored-by: Marius Darila --- .env.example | 3 + .gitignore | 9 +- .yarnrc.yml | 14 + README.md | 29 +- akasha-core | 2 +- docs/design-system/_category.json | 4 + docs/design-system/components/_category.json | 4 + docs/design-system/components/index.md | 6 + docs/design-system/core/_category.json | 4 + docs/design-system/core/index.md | 59 + docs/design-system/index.md | 19 + docs/dev-quickstart.md | 69 +- docs/glossary.md | 25 + docs/index.md | 58 +- .../integrations/applications/_category_.json | 2 +- .../applications/create-an-app.md | 4 +- docs/integrations/applications/index.md | 68 +- docs/integrations/content-blocks.md | 117 + docs/integrations/editor.md | 19 + docs/integrations/extensions.md | 57 + docs/integrations/index.md | 22 +- docs/integrations/layout-widget.md | 65 +- docs/integrations/loading-function.md | 28 + docs/integrations/plugins.md | 75 + docs/integrations/ui-event-bus.md | 26 +- docs/integrations/widgets/_category_.json | 2 +- docs/integrations/widgets/index.md | 71 +- docs/react-hooks/_category_.yml | 2 - docs/react-hooks/_hooks-list_.md | 187 - docs/react-hooks/enums/CookieConsentTypes.md | 27 - docs/react-hooks/enums/_category_.yml | 2 - docs/react-hooks/index.md | 195 - docs/react-hooks/interfaces/EntryReport.md | 87 - .../react-hooks/interfaces/FormProfileData.md | 95 - docs/react-hooks/interfaces/ICount.md | 37 - docs/react-hooks/interfaces/ILogItem.md | 87 - docs/react-hooks/interfaces/IModeratedItem.md | 249 - docs/react-hooks/interfaces/IPendingItem.md | 153 - docs/react-hooks/interfaces/LoginState.md | 109 - docs/react-hooks/interfaces/_category_.yml | 2 - docs/react-hooks/modules.md | 4710 --- docs/sdk/api-reference/_category_.yml | 2 - docs/sdk/api-reference/classes/_category_.yml | 2 - .../sdk/api-reference/classes/sdk.AWF_Auth.md | 610 - .../api-reference/classes/sdk.AWF_Comments.md | 187 - docs/sdk/api-reference/classes/sdk.AWF_ENS.md | 192 - .../api-reference/classes/sdk.AWF_Entry.md | 238 - .../classes/sdk.AWF_IC_REGISTRY.md | 291 - .../classes/sdk.AWF_IpfsConnector.md | 290 - .../sdk/api-reference/classes/sdk.AWF_Misc.md | 67 - .../api-reference/classes/sdk.AWF_Profile.md | 559 - .../sdk/api-reference/classes/sdk.AWF_Tags.md | 129 - .../api-reference/classes/sdk.AppSettings.md | 176 - docs/sdk/api-reference/classes/sdk.DB.md | 79 - .../sdk/api-reference/classes/sdk.EventBus.md | 40 - docs/sdk/api-reference/classes/sdk.Gql.md | 127 - docs/sdk/api-reference/classes/sdk.Logging.md | 44 - .../sdk/api-reference/classes/sdk.Settings.md | 93 - docs/sdk/api-reference/classes/sdk.Stash.md | 86 - .../classes/sdk.Web3Connector.md | 227 - .../api-reference/classes/sdk.default-1.md | 112 - .../api-reference/classes/sdk.default-2.md | 328 - docs/sdk/api-reference/classes/sdk.default.md | 147 - docs/sdk/api-reference/enums/_category_.yml | 2 - .../api-reference/enums/sdk.EthProviders.md | 62 - .../enums/sdk.INJECTED_PROVIDERS.md | 132 - .../sdk/api-reference/enums/sdk.LEGAL_DOCS.md | 62 - docs/sdk/api-reference/enums/sdk.PostType.md | 52 - .../api-reference/enums/typings.APP_EVENTS.md | 62 - .../enums/typings.AUTH_EVENTS.md | 162 - .../enums/typings.COMMENTS_EVENTS.md | 42 - .../api-reference/enums/typings.ENS_EVENTS.md | 32 - .../enums/typings.ENTRY_EVENTS.md | 42 - .../enums/typings.EthProviders.md | 62 - .../enums/typings.INJECTED_PROVIDERS.md | 132 - .../api-reference/enums/typings.LEGAL_DOCS.md | 62 - .../enums/typings.PROFILE_EVENTS.md | 72 - .../enums/typings.PROVIDER_ERROR_CODES.md | 42 - .../api-reference/enums/typings.PostType.md | 42 - .../api-reference/enums/typings.TAG_EVENTS.md | 22 - .../enums/typings.WEB3_EVENTS.md | 62 - .../enums/typings.events.APP_EVENTS.md | 62 - .../enums/typings.events.AUTH_EVENTS.md | 152 - .../enums/typings.events.COMMENTS_EVENTS.md | 42 - .../enums/typings.events.ENS_EVENTS.md | 32 - .../enums/typings.events.ENTRY_EVENTS.md | 42 - .../enums/typings.events.PROFILE_EVENTS.md | 72 - .../enums/typings.events.TAG_EVENTS.md | 22 - .../enums/typings.events.WEB3_EVENTS.md | 52 - docs/sdk/api-reference/index.md | 90 - docs/sdk/api-reference/interfaces/AWF_SDK.md | 31 - docs/sdk/api-reference/interfaces/SDK_API.md | 91 - .../api-reference/interfaces/SDK_Services.md | 99 - .../api-reference/interfaces/_category_.yml | 2 - .../interfaces/sdk.AWF_APP_SOURCE_MANIFEST.md | 62 - .../api-reference/interfaces/sdk.AWF_IAuth.md | 310 - .../interfaces/sdk.AWF_IComments.md | 132 - .../api-reference/interfaces/sdk.AWF_IENS.md | 136 - .../interfaces/sdk.AWF_IEntry.md | 217 - .../interfaces/sdk.AWF_IIC_REGISTRY.md | 192 - .../interfaces/sdk.AWF_IIpfsConnector.md | 84 - .../interfaces/sdk.AWF_IProfile.md | 388 - .../api-reference/interfaces/sdk.AWF_ITags.md | 112 - .../interfaces/sdk.AppsSchema.md | 82 - .../interfaces/sdk.Comment_Response.md | 92 - .../interfaces/sdk.Comments_Response.md | 42 - .../interfaces/sdk.ConfigInfo.md | 32 - .../interfaces/sdk.CurrentUser.md | 52 - .../interfaces/sdk.DataProviderInput.md | 42 - .../interfaces/sdk.GlobalSearchResult.md | 52 - .../interfaces/sdk.GlobalSearchResultItem.md | 32 - .../sdk.GlobalSearchResultTagItem.md | 42 - .../interfaces/sdk.GqlOperation.md | 62 - .../interfaces/sdk.IAppSettings.md | 100 - .../interfaces/sdk.IDBService.md | 77 - .../interfaces/sdk.IGqlClient.md | 38 - .../interfaces/sdk.ILogService.md | 36 - .../api-reference/interfaces/sdk.ILogger.md | 92 - .../api-reference/interfaces/sdk.IMessage.md | 62 - .../interfaces/sdk.ISettingsService.md | 77 - .../interfaces/sdk.IStashService.md | 76 - .../interfaces/sdk.IWeb3Connector.md | 134 - .../interfaces/sdk.IntegrationInfo.md | 72 - .../interfaces/sdk.IntegrationSchema.md | 82 - .../interfaces/sdk.LRUOptions.md | 32 - .../interfaces/sdk.LinkPreview_Response.md | 102 - .../interfaces/sdk.Post_Response.md | 142 - .../interfaces/sdk.PostsResult_Response.md | 42 - .../interfaces/sdk.ReleaseInfo.md | 130 - .../sdk.SearchTagsResult_Response.md | 32 - .../interfaces/sdk.SettingsSchema.md | 42 - .../interfaces/sdk.Tag_Response.md | 72 - .../interfaces/sdk.TagsResult_Response.md | 42 - .../interfaces/sdk.UserFollowers_Response.md | 42 - .../interfaces/sdk.UserProfile_Response.md | 162 - .../interfaces/sdk.VersionInfo.md | 32 - .../interfaces/sdk.VideoPreview_Response.md | 62 - .../typings.AWF_APP_BUILD_MANIFEST.md | 40 - .../typings.AWF_APP_SOURCE_MANIFEST.md | 62 - .../interfaces/typings.AWF_IAuth.md | 310 - .../interfaces/typings.AWF_IComments.md | 132 - .../interfaces/typings.AWF_IENS.md | 136 - .../interfaces/typings.AWF_IEntry.md | 217 - .../interfaces/typings.AWF_IIC_REGISTRY.md | 192 - .../interfaces/typings.AWF_IIpfsConnector.md | 84 - .../interfaces/typings.AWF_IProfile.md | 388 - .../interfaces/typings.AWF_ITags.md | 112 - .../interfaces/typings.Comment_Response.md | 92 - .../interfaces/typings.Comments_Response.md | 42 - .../interfaces/typings.CurrentUser.md | 52 - .../interfaces/typings.DataProviderInput.md | 42 - .../interfaces/typings.GlobalSearchResult.md | 52 - .../typings.GlobalSearchResultItem.md | 32 - .../typings.GlobalSearchResultTagItem.md | 42 - .../interfaces/typings.IAppSettings.md | 101 - .../interfaces/typings.IAwfSDK.md | 45 - .../interfaces/typings.IDBService.md | 73 - .../interfaces/typings.IGqlClient.md | 38 - .../interfaces/typings.ILogService.md | 36 - .../interfaces/typings.ILogger.md | 92 - .../interfaces/typings.IMessage.md | 72 - .../interfaces/typings.IServices.md | 89 - .../interfaces/typings.ISettingsService.md | 77 - .../interfaces/typings.IStashService.md | 76 - .../interfaces/typings.IWeb3Connector.md | 134 - .../interfaces/typings.IntegrationInfo.md | 72 - .../interfaces/typings.LRUOptions.md | 32 - .../typings.LinkPreview_Response.md | 122 - .../interfaces/typings.Post_Response.md | 142 - .../typings.PostsResult_Response.md | 42 - .../interfaces/typings.ReleaseInfo.md | 130 - .../typings.SearchTagsResult_Response.md | 32 - .../interfaces/typings.Services.md | 91 - .../interfaces/typings.Tag_Response.md | 72 - .../interfaces/typings.TagsResult_Response.md | 42 - .../typings.UserFollowers_Response.md | 42 - .../typings.UserProfile_Response.md | 162 - .../typings.VideoPreview_Response.md | 62 - docs/sdk/api-reference/modules.md | 71 - docs/sdk/api-reference/modules/_category_.yml | 2 - docs/sdk/api-reference/modules/sdk.md | 2130 -- .../api-reference/namespaces/_category_.yml | 2 - docs/sdk/api-reference/namespaces/sdk.md | 2130 -- .../namespaces/typings.events.md | 23 - docs/sdk/api-reference/namespaces/typings.md | 544 - docs/sdk/index.md | 6 +- docs/sdk/sdk-instance.md | 200 - docs/workspace-structure.md | 33 +- docusaurus.config.js | 72 +- package.json | 3 +- yarn.lock | 25493 +++++++++------- 191 files changed, 15695 insertions(+), 35624 deletions(-) create mode 100644 .env.example create mode 100644 .yarnrc.yml create mode 100644 docs/design-system/_category.json create mode 100644 docs/design-system/components/_category.json create mode 100644 docs/design-system/components/index.md create mode 100644 docs/design-system/core/_category.json create mode 100644 docs/design-system/core/index.md create mode 100644 docs/design-system/index.md create mode 100644 docs/glossary.md create mode 100644 docs/integrations/content-blocks.md create mode 100644 docs/integrations/editor.md create mode 100644 docs/integrations/extensions.md create mode 100644 docs/integrations/loading-function.md create mode 100644 docs/integrations/plugins.md delete mode 100644 docs/react-hooks/_category_.yml delete mode 100644 docs/react-hooks/_hooks-list_.md delete mode 100644 docs/react-hooks/enums/CookieConsentTypes.md delete mode 100644 docs/react-hooks/enums/_category_.yml delete mode 100644 docs/react-hooks/index.md delete mode 100644 docs/react-hooks/interfaces/EntryReport.md delete mode 100644 docs/react-hooks/interfaces/FormProfileData.md delete mode 100644 docs/react-hooks/interfaces/ICount.md delete mode 100644 docs/react-hooks/interfaces/ILogItem.md delete mode 100644 docs/react-hooks/interfaces/IModeratedItem.md delete mode 100644 docs/react-hooks/interfaces/IPendingItem.md delete mode 100644 docs/react-hooks/interfaces/LoginState.md delete mode 100644 docs/react-hooks/interfaces/_category_.yml delete mode 100644 docs/react-hooks/modules.md delete mode 100644 docs/sdk/api-reference/_category_.yml delete mode 100644 docs/sdk/api-reference/classes/_category_.yml delete mode 100644 docs/sdk/api-reference/classes/sdk.AWF_Auth.md delete mode 100644 docs/sdk/api-reference/classes/sdk.AWF_Comments.md delete mode 100644 docs/sdk/api-reference/classes/sdk.AWF_ENS.md delete mode 100644 docs/sdk/api-reference/classes/sdk.AWF_Entry.md delete mode 100644 docs/sdk/api-reference/classes/sdk.AWF_IC_REGISTRY.md delete mode 100644 docs/sdk/api-reference/classes/sdk.AWF_IpfsConnector.md delete mode 100644 docs/sdk/api-reference/classes/sdk.AWF_Misc.md delete mode 100644 docs/sdk/api-reference/classes/sdk.AWF_Profile.md delete mode 100644 docs/sdk/api-reference/classes/sdk.AWF_Tags.md delete mode 100644 docs/sdk/api-reference/classes/sdk.AppSettings.md delete mode 100644 docs/sdk/api-reference/classes/sdk.DB.md delete mode 100644 docs/sdk/api-reference/classes/sdk.EventBus.md delete mode 100644 docs/sdk/api-reference/classes/sdk.Gql.md delete mode 100644 docs/sdk/api-reference/classes/sdk.Logging.md delete mode 100644 docs/sdk/api-reference/classes/sdk.Settings.md delete mode 100644 docs/sdk/api-reference/classes/sdk.Stash.md delete mode 100644 docs/sdk/api-reference/classes/sdk.Web3Connector.md delete mode 100644 docs/sdk/api-reference/classes/sdk.default-1.md delete mode 100644 docs/sdk/api-reference/classes/sdk.default-2.md delete mode 100644 docs/sdk/api-reference/classes/sdk.default.md delete mode 100644 docs/sdk/api-reference/enums/_category_.yml delete mode 100644 docs/sdk/api-reference/enums/sdk.EthProviders.md delete mode 100644 docs/sdk/api-reference/enums/sdk.INJECTED_PROVIDERS.md delete mode 100644 docs/sdk/api-reference/enums/sdk.LEGAL_DOCS.md delete mode 100644 docs/sdk/api-reference/enums/sdk.PostType.md delete mode 100644 docs/sdk/api-reference/enums/typings.APP_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.AUTH_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.COMMENTS_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.ENS_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.ENTRY_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.EthProviders.md delete mode 100644 docs/sdk/api-reference/enums/typings.INJECTED_PROVIDERS.md delete mode 100644 docs/sdk/api-reference/enums/typings.LEGAL_DOCS.md delete mode 100644 docs/sdk/api-reference/enums/typings.PROFILE_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.PROVIDER_ERROR_CODES.md delete mode 100644 docs/sdk/api-reference/enums/typings.PostType.md delete mode 100644 docs/sdk/api-reference/enums/typings.TAG_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.WEB3_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.events.APP_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.events.AUTH_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.events.COMMENTS_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.events.ENS_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.events.ENTRY_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.events.PROFILE_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.events.TAG_EVENTS.md delete mode 100644 docs/sdk/api-reference/enums/typings.events.WEB3_EVENTS.md delete mode 100644 docs/sdk/api-reference/index.md delete mode 100644 docs/sdk/api-reference/interfaces/AWF_SDK.md delete mode 100644 docs/sdk/api-reference/interfaces/SDK_API.md delete mode 100644 docs/sdk/api-reference/interfaces/SDK_Services.md delete mode 100644 docs/sdk/api-reference/interfaces/_category_.yml delete mode 100644 docs/sdk/api-reference/interfaces/sdk.AWF_APP_SOURCE_MANIFEST.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.AWF_IAuth.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.AWF_IComments.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.AWF_IENS.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.AWF_IEntry.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.AWF_IIC_REGISTRY.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.AWF_IIpfsConnector.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.AWF_IProfile.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.AWF_ITags.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.AppsSchema.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.Comment_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.Comments_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.ConfigInfo.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.CurrentUser.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.DataProviderInput.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.GlobalSearchResult.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.GlobalSearchResultItem.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.GlobalSearchResultTagItem.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.GqlOperation.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.IAppSettings.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.IDBService.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.IGqlClient.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.ILogService.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.ILogger.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.IMessage.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.ISettingsService.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.IStashService.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.IWeb3Connector.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.IntegrationInfo.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.IntegrationSchema.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.LRUOptions.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.LinkPreview_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.Post_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.PostsResult_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.ReleaseInfo.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.SearchTagsResult_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.SettingsSchema.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.Tag_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.TagsResult_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.UserFollowers_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.UserProfile_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.VersionInfo.md delete mode 100644 docs/sdk/api-reference/interfaces/sdk.VideoPreview_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.AWF_APP_BUILD_MANIFEST.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.AWF_APP_SOURCE_MANIFEST.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.AWF_IAuth.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.AWF_IComments.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.AWF_IENS.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.AWF_IEntry.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.AWF_IIC_REGISTRY.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.AWF_IIpfsConnector.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.AWF_IProfile.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.AWF_ITags.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.Comment_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.Comments_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.CurrentUser.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.DataProviderInput.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.GlobalSearchResult.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.GlobalSearchResultItem.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.GlobalSearchResultTagItem.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.IAppSettings.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.IAwfSDK.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.IDBService.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.IGqlClient.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.ILogService.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.ILogger.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.IMessage.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.IServices.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.ISettingsService.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.IStashService.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.IWeb3Connector.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.IntegrationInfo.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.LRUOptions.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.LinkPreview_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.Post_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.PostsResult_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.ReleaseInfo.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.SearchTagsResult_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.Services.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.Tag_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.TagsResult_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.UserFollowers_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.UserProfile_Response.md delete mode 100644 docs/sdk/api-reference/interfaces/typings.VideoPreview_Response.md delete mode 100644 docs/sdk/api-reference/modules.md delete mode 100644 docs/sdk/api-reference/modules/_category_.yml delete mode 100644 docs/sdk/api-reference/modules/sdk.md delete mode 100644 docs/sdk/api-reference/namespaces/_category_.yml delete mode 100644 docs/sdk/api-reference/namespaces/sdk.md delete mode 100644 docs/sdk/api-reference/namespaces/typings.events.md delete mode 100644 docs/sdk/api-reference/namespaces/typings.md delete mode 100644 docs/sdk/sdk-instance.md diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..71d43a0 --- /dev/null +++ b/.env.example @@ -0,0 +1,3 @@ +ALGOLIA_APP_ID= +ALGOLIA_API_KEY= +ALGOLIA_INDEX_NAME= \ No newline at end of file diff --git a/.gitignore b/.gitignore index a7ae08f..102d767 100644 --- a/.gitignore +++ b/.gitignore @@ -48,8 +48,9 @@ typings/ # TypeScript cache *.tsbuildinfo -# Optional npm cache directory +# Optional npm/yarn cache directory .npm +.yarn # Optional eslint cache .eslintcache @@ -107,3 +108,9 @@ dist .idea **/.DS_Store .docusaurus + +*.gz + +# generated docs folders +docs/react-hooks/ +docs/sdk/api-reference/ \ No newline at end of file diff --git a/.yarnrc.yml b/.yarnrc.yml new file mode 100644 index 0000000..951392e --- /dev/null +++ b/.yarnrc.yml @@ -0,0 +1,14 @@ +compressionLevel: mixed + +enableGlobalCache: false + +enableColors: true + + +nodeLinker: node-modules + +injectEnvironmentFiles: [ + ".env.local?", + ".env.development.local?", + ".env?" +] diff --git a/README.md b/README.md index aaba2fa..1e95566 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,38 @@ -# Website +# AKASHA Documentation This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. +## Local Development + +### Init and Update Submodules +First time running this project locally? please use; +``` +$ git submodule update --init --recursive +``` + +This fetches and updates the linked submodules. Subsequently, you may use; +``` +$ git submodule update --recursive --remote +``` + +### Set up Algolia +- Create an account on Algolia (if you already have one, skip to next step) +- Create an Index and copy out its `Application ID` and `Search API Key` +- Update the matching fields in the [config file](./docusaurus.config.js) +- Read more about the DocSearch Migration [here](https://docusaurus.io/blog/2021/11/21/algolia-docsearch-migration) + ### Installation ``` $ yarn ``` -### Local Development +### Bootstrap files +``` +$ yarn run bootstrap +``` +### Start Local Server ``` $ yarn start ``` @@ -24,7 +47,7 @@ $ yarn build This command generates static content into the `build` directory and can be served using any static contents hosting service. -### Deployment +### Deploy Using SSH: diff --git a/akasha-core b/akasha-core index 1934fda..72c56d5 160000 --- a/akasha-core +++ b/akasha-core @@ -1 +1 @@ -Subproject commit 1934fda0c5f7f776abefb6b62fa71582a43f210a +Subproject commit 72c56d5f55f28a7a657b514487429262417b0011 diff --git a/docs/design-system/_category.json b/docs/design-system/_category.json new file mode 100644 index 0000000..b86110e --- /dev/null +++ b/docs/design-system/_category.json @@ -0,0 +1,4 @@ +{ + "label": "Design System", + "position": 4 +} diff --git a/docs/design-system/components/_category.json b/docs/design-system/components/_category.json new file mode 100644 index 0000000..50c4b6d --- /dev/null +++ b/docs/design-system/components/_category.json @@ -0,0 +1,4 @@ +{ + "label": "Design System Components", + "position": 2 +} diff --git a/docs/design-system/components/index.md b/docs/design-system/components/index.md new file mode 100644 index 0000000..8a9cee3 --- /dev/null +++ b/docs/design-system/components/index.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 2 +sidebar_label: Design System Components +--- + +# Design System Components \ No newline at end of file diff --git a/docs/design-system/core/_category.json b/docs/design-system/core/_category.json new file mode 100644 index 0000000..c9d916c --- /dev/null +++ b/docs/design-system/core/_category.json @@ -0,0 +1,4 @@ +{ + "label": "Design System Core", + "position": 1 +} diff --git a/docs/design-system/core/index.md b/docs/design-system/core/index.md new file mode 100644 index 0000000..b38a3ad --- /dev/null +++ b/docs/design-system/core/index.md @@ -0,0 +1,59 @@ +--- +sidebar_position: 1 +sidebar_label: Design System Core +--- + +# Design System Core + +## Button + +A button component presents two variants: `primary` for the call-to-action use case and `secondary` for regular usage. It usually has rounder borders, can display an icon, or it can be text only. + +```tsx +