From 361becd9ad5740907931101b48ff8d70830e5a25 Mon Sep 17 00:00:00 2001 From: Praise Obende Date: Sun, 6 Nov 2022 19:34:03 +0100 Subject: [PATCH 1/2] Remove the blog page and the help link in the header and blog link in the footer that redirects to the blog page ZCG_28 --- blog/2021-08-01-mdx-blog-post.mdx | 4 +- docusaurus.config.js | 207 ++++++++++++++---------------- 2 files changed, 101 insertions(+), 110 deletions(-) diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx index c04ebe3..ad3490f 100644 --- a/blog/2021-08-01-mdx-blog-post.mdx +++ b/blog/2021-08-01-mdx-blog-post.mdx @@ -12,9 +12,9 @@ Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/mar Use the power of React to create interactive blog posts. ```js - + ``` - + ::: diff --git a/docusaurus.config.js b/docusaurus.config.js index 254f267..b2b5526 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -4,114 +4,105 @@ const darkCodeTheme = require("prism-react-renderer/themes/palenight"); // With JSDoc @type annotations, IDEs can provide config autocompletion /** @type {import('@docusaurus/types').DocusaurusConfig} */ ( - module.exports = { - title: "Zuri Chat", - tagline: "Developer docs and guides", - url: "https://docs.zuri.chat", - baseUrl: "/", - onBrokenLinks: "ignore", - onBrokenMarkdownLinks: "warn", - favicon: "img/zurichatlogo.svg", - organizationName: "zurichat/", // Usually your GitHub org/user name. - projectName: "documention", // Usually your repo name. + module.exports = { + title: "Zuri Chat", + tagline: "Developer docs and guides", + url: "https://docs.zuri.chat", + baseUrl: "/", + onBrokenLinks: "ignore", + onBrokenMarkdownLinks: "warn", + favicon: "img/zurichatlogo.svg", + organizationName: "zurichat/", // Usually your GitHub org/user name. + projectName: "documention", // Usually your repo name. - presets: [ - [ - "@docusaurus/preset-classic", - /** @type {import('@docusaurus/preset-classic').Options} */ - ({ - docs: { - routeBasePath: "/", - sidebarPath: require.resolve("./sidebars.js"), - // Please change this to your repo. - editUrl: "https://github.com/zurichat/documention/", - }, - blog: { - showReadingTime: true, - // Please change this to your repo. - editUrl: - "https://github.com/zurichat/documention/tree/main/blog/", - }, - theme: { - customCss: require.resolve("./src/css/custom.css"), - }, - }), - ], - ], + presets: [ + [ + "@docusaurus/preset-classic", + /** @type {import('@docusaurus/preset-classic').Options} */ + ({ + docs: { + routeBasePath: "/", + sidebarPath: require.resolve("./sidebars.js"), + // Please change this to your repo. + editUrl: "https://github.com/zurichat/documention/", + }, + blog: false, + theme: { + customCss: require.resolve("./src/css/custom.css"), + }, + }), + ], + ], - themeConfig: - /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ - ({ - navbar: { - title: "Zuri Chat", - logo: { - alt: "Zuri Chat Logo", - src: "img/zurichatlogo.svg", - }, - items: [ - { - type: "doc", - docId: "intro", - position: "left", - label: "Docs", - }, - { to: "/blog", label: "Help", position: "left" }, - { - href: "https://github.com/zurichat/documention", - label: "GitHub", - position: "right", - }, - ], - }, - footer: { - style: "dark", - links: [ - { - title: "Docs", - items: [ - { - label: "Documentation", - to: "/docs/intro", - }, - ], - }, - { - title: "Community", - items: [ - { - label: "Stack Overflow", - href: "https://stackoverflow.com/questions/tagged/docusaurus", - }, - { - label: "Discord", - href: "https://discordapp.com/invite/docusaurus", - }, - { - label: "Twitter", - href: "https://twitter.com/hngi", - }, - ], - }, - { - title: "More", - items: [ - { - label: "Blog", - to: "/blog", - }, - { - label: "GitHub", - href: "https://github.com/facebook/docusaurus", - }, - ], - }, - ], - copyright: `Copyright © ${new Date().getFullYear()} Zuri Chat, Inc. Built with Docusaurus.`, - }, - prism: { - theme: lightCodeTheme, - darkTheme: darkCodeTheme, - }, - }), - } + themeConfig: + /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ + ({ + navbar: { + title: "Zuri Chat", + logo: { + alt: "Zuri Chat Logo", + src: "img/zurichatlogo.svg", + }, + items: [ + { + type: "doc", + docId: "intro", + position: "left", + label: "Docs", + }, + + { + href: "https://github.com/zurichat/documention", + label: "GitHub", + position: "right", + }, + ], + }, + footer: { + style: "dark", + links: [ + { + title: "Docs", + items: [ + { + label: "Documentation", + to: "/docs/intro", + }, + ], + }, + { + title: "Community", + items: [ + { + label: "Stack Overflow", + href: "https://stackoverflow.com/questions/tagged/docusaurus", + }, + { + label: "Discord", + href: "https://discordapp.com/invite/docusaurus", + }, + { + label: "Twitter", + href: "https://twitter.com/hngi", + }, + ], + }, + { + title: "More", + items: [ + { + label: "GitHub", + href: "https://github.com/facebook/docusaurus", + }, + ], + }, + ], + copyright: `Copyright © ${new Date().getFullYear()} Zuri Chat, Inc. Built with Docusaurus.`, + }, + prism: { + theme: lightCodeTheme, + darkTheme: darkCodeTheme, + }, + }), + } ); From ddbc82f37a9c4b31dcd1d7dc67a21e58a3e6c9ab Mon Sep 17 00:00:00 2001 From: Praise Obende Date: Sun, 6 Nov 2022 19:53:02 +0100 Subject: [PATCH 2/2] ZCG_26 Clean up Zuri Chat docs to be neater --- docs/add_remove | 0 docs/add_remove.md | 2 +- docs/create-workspace.md | 2 +- docs/eunice.md | 0 docs/zuri_main.md | 2 +- 5 files changed, 3 insertions(+), 3 deletions(-) delete mode 100644 docs/add_remove delete mode 100644 docs/eunice.md diff --git a/docs/add_remove b/docs/add_remove deleted file mode 100644 index e69de29..0000000 diff --git a/docs/add_remove.md b/docs/add_remove.md index 2256f1c..6e39037 100644 --- a/docs/add_remove.md +++ b/docs/add_remove.md @@ -1,4 +1,4 @@ -### Add/Remove Endpoints For All Plugins +# Add/Remove Endpoints For All Plugins ## Brief Contains all the add/remove endpoints/instructions for all teams diff --git a/docs/create-workspace.md b/docs/create-workspace.md index b5e133e..72f4086 100644 --- a/docs/create-workspace.md +++ b/docs/create-workspace.md @@ -1,4 +1,4 @@ -# Create-Workspace Workflow +# Create Workspace Workflow This workflow enables a user of the zurichat app to create a workspace on the app **Name of Endpoint Consumed** diff --git a/docs/eunice.md b/docs/eunice.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/zuri_main.md b/docs/zuri_main.md index 34d1717..58f469e 100644 --- a/docs/zuri_main.md +++ b/docs/zuri_main.md @@ -1,4 +1,4 @@ -# zuri-main-documentation +# Zuri Main Documentation ## Create User Account To use zuri chat you need to sign up or sign in if you already have an account.