From f1e8482e6334119da49e65e6ca8e4aa954bea253 Mon Sep 17 00:00:00 2001 From: jose-donato <43375532+jose-donato@users.noreply.github.com> Date: Fri, 25 Nov 2022 19:50:41 +0000 Subject: [PATCH] Docs website fixes (#3580) * feat: fixes on docs website * fix: added installers to docs, 404 and header Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com> --- .../terminal/quickstart/installation.md | 18 ++---- website/src/theme/Navbar/Layout/index.js | 2 +- website/src/theme/NotFound.js | 64 +++++++++++++++++++ 3 files changed, 72 insertions(+), 12 deletions(-) create mode 100644 website/src/theme/NotFound.js diff --git a/website/content/terminal/quickstart/installation.md b/website/content/terminal/quickstart/installation.md index 8d5a6841b3a..6ea5efe7c08 100644 --- a/website/content/terminal/quickstart/installation.md +++ b/website/content/terminal/quickstart/installation.md @@ -16,11 +16,8 @@ OpenBB Terminal is available in all major platforms. With MacOS/Windows you can Install on Windows
-

The process starts off by downloading the installer, see below for how to download the most recent release:

-
    -
  1. Go to the OpenBB website.
    2. -
  2. Click on the Download button in the Windows Installer section.
    3. -
+

Download the installer from the here.

+

When the file is downloaded, use the following steps to run the OpenBB Terminal:

@@ -51,12 +48,11 @@ still in beta phase, and the team has not yet requested verification from Window Install on macOS 🍎 -
-

The process starts off by downloading the installer, see below for how to download the most recent release:

-
    -
  1. Go to the OpenBB website.
    2. -
  2. Click on the Download button in the macOS Installer section.
    3. -
+For mac there are two installers available, one for Intel and one for Apple Silicon (M1). Please download the correct one for your machine. +
    +
  • If you are using Mac Intel click here to download the installer.
    • +
  • If you are using Mac Apple Silicon (M1) click here to download the installer.
    • +

When the DMG file is downloaded, use the following steps to run the OpenBB Terminal:

diff --git a/website/src/theme/Navbar/Layout/index.js b/website/src/theme/Navbar/Layout/index.js index 81622321ffe..c8680930471 100644 --- a/website/src/theme/Navbar/Layout/index.js +++ b/website/src/theme/Navbar/Layout/index.js @@ -47,7 +47,7 @@ export default function NavbarLayout({ children }) { { header_docs_terminal: pathname.startsWith("/terminal"), header_docs_sdk: pathname.startsWith("/sdk"), - header_docs: pathname === "/", + header_docs: !pathname.startsWith("/terminal") && !pathname.startsWith("/sdk"), }, "navbar", "navbar--fixed-top", diff --git a/website/src/theme/NotFound.js b/website/src/theme/NotFound.js new file mode 100644 index 00000000000..3ddc4fd14c0 --- /dev/null +++ b/website/src/theme/NotFound.js @@ -0,0 +1,64 @@ +import React from 'react'; +import Translate, {translate} from '@docusaurus/Translate'; +import {PageMetadata} from '@docusaurus/theme-common'; +import Layout from '@theme/Layout'; +export default function NotFound() { + return ( + <> + + +
+
+
+

+ + Page Not Found + +

+

+ We could not find what you were looking for. +

+

+ We recently moved our documentation to a new location and some links may be broken. Popular links are listed below: +

+ +
+
+
+ + + ); +}