jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-09 02:42:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs website fixes (#3580)

Browse Source 
* feat: fixes on docs website

* fix: added installers to docs, 404 and header

Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
This commit is contained in:
jose-donato
2022-11-25 19:50:41 +00:00
committed by GitHub
parent 598044ac6a
commit f1e8482e63
3 changed files with 72 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
website/content/terminal/quickstart/installation.md vendored
View File

@@ -16,11 +16,8 @@ OpenBB Terminal is available in all major platforms. With MacOS/Windows you can
<TabItem value="Windows" label="Windows">Install on Windows
<div class="gdoc-page">
</div><p>The process starts off by downloading the installer, see below for how to download the most recent release:</p>
<ol>
<li>Go to the <a href="https://www.openbb.co/products/terminal#get-started" target="_blank">OpenBB website</a>.</li>
<li>Click on the <code>Download</code> button in the Windows Installer section.</li>
</ol>
</div><p>Download the installer from the <a href="https://github.com/OpenBB-finance/OpenBBTerminal/releases/download/v1.9.0/Windows10.OpenBB.Terminal.v1.9.0.exe">here</a>.</p>
<p>When the file is downloaded, use the following steps to run the OpenBB Terminal:</p>
<div class="gdoc-columns">
@@ -51,12 +48,11 @@ still in beta phase, and the team has not yet requested verification from Window
<TabItem value="macOS" label="MacOS">Install on macOS 🍎
<div class="gdoc-page">
</div><p>The process starts off by downloading the installer, see below for how to download the most recent release:</p>
<ol>
<li>Go to the <a href="https://www.openbb.co/products/terminal#get-started" target="_blank">OpenBB website</a>.</li>
<li>Click on the <code>Download</code> button in the macOS Installer section.</li>
</ol>
For mac there are two installers available, one for Intel and one for Apple Silicon (M1). Please download the correct one for your machine.
<ul>
<li>If you are using Mac Intel click <a href="https://github.com/OpenBB-finance/OpenBBTerminal/releases/download/v1.9.0/x86_64.MacOS.OpenBB.Terminal.v1.9.0.dmg">here</a> to download the installer.</li>
<li>If you are using Mac Apple Silicon (M1) click <a href="https://github.com/OpenBB-finance/OpenBBTerminal/releases/download/v1.9.0/ARM64.MacOS.OpenBB.Terminal.v1.9.0.dmg">here</a> to download the installer.</li>
</ul>
<p>When the DMG file is downloaded, use the following steps to run the OpenBB Terminal:</p>
<div class="gdoc-columns">

2
website/src/theme/Navbar/Layout/index.js vendored
View File

@@ -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",

64
website/src/theme/NotFound.js vendored Normal file
View File

@@ -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 (
<>
<PageMetadata
title={translate({
id: 'theme.NotFound.title',
message: 'Page Not Found',
})}
/>
<Layout>
<main className="container margin-vert--xl">
<div className="row">
<div className="col col--6 col--offset-3">
<h1 className="mt-10 !text-[32px] uppercase font-bold tracking-widest">
<Translate
id="theme.NotFound.title"
description="The title of the 404 page">
Page Not Found
</Translate>
</h1>
<p className='mt-6 mb-2'>
We could not find what you were looking for.
</p>
<p>
We recently moved our documentation to a new location and some links may be broken. Popular links are listed below:
</p>
<ul className='space-y-1 max-w-md list-disc list-inside mt-4'>
<li>
<a href="/">Homepage</a>
</li>
<li>
<a href="/sdk">Terminal Documentation</a>
<ul className='space-y-1 max-w-md list-disc ml-4 mt-2 mb-3 list-inside'>
<li>
<a href="/terminal/quickstart/installation">Terminal Installation</a>
</li>
<li>
<a href="/terminal/reference">Terminal Reference</a>
</li>
</ul>
</li>
<li>
<a href="/sdk">SDK Documentation</a>
<ul className='space-y-1 max-w-md list-disc ml-4 mt-2 mb-3 list-inside'>
<li>
<a href="/sdk/quickstart/installation">SDK Installation</a>
</li>
<li>
<a href="/sdk/reference">SDK Reference</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</main>
</Layout>
</>
);
}