[site] Add documentation page with links into books
Co-authored-by: Douglas Reis <doreis@lowrisc.org>
Co-authored-by: Harry Callahan <hcallahan@lowrisc.org>
Co-authored-by: Hugo McNally <hugo.mcnally@gmail.com>
Co-authored-by: Jorge Prendes <jorge.prendes@gmail.com>
Co-authored-by: Marno van der Maas <mvdmaas+git@lowrisc.org>
Signed-off-by: James Wainwright <james.wainwright@lowrisc.org>
diff --git a/site/landing/assets/scss/_boxes.scss b/site/landing/assets/scss/_boxes.scss
new file mode 100644
index 0000000..f05fbbe
--- /dev/null
+++ b/site/landing/assets/scss/_boxes.scss
@@ -0,0 +1,39 @@
+.tiles__wrapper {
+ width: 100%;
+}
+
+.tiles__container {
+ display: grid;
+ grid-template-columns: 1fr 1fr 1fr 1fr 1fr 1fr;
+ grid-template-rows: 1fr;
+
+ width: 90vw;
+ padding: 0.8em;
+ gap: 0.8em;
+ max-width: 50em;
+ border-radius: 0.5em;
+ margin: auto;
+
+ opacity: 0.8;
+ background: var(--rainbow);
+}
+
+.tile {
+ display: grid;
+ justify-content: center;
+ align-items: center;
+
+ border-radius: 0.3em;
+ padding: 0.5em;
+
+ font-size: 1.2em;
+ text-decoration: none;
+ text-align: center;
+
+ background: var(--background);
+ color: var(--text-color);
+}
+
+.tile:visited {
+ color: var(--text-color);
+}
diff --git a/site/landing/assets/scss/_content-body.scss b/site/landing/assets/scss/_content-body.scss
new file mode 100644
index 0000000..631a0a8
--- /dev/null
+++ b/site/landing/assets/scss/_content-body.scss
@@ -0,0 +1,18 @@
+main {
+ background: var(--background);
+ color: var(--text-color);
+ padding: 0.75em $m-s;
+}
+
+.content {
+ margin: 0 auto;
+ max-width: $max-width-m;
+}
+
+/* Get the default margins back for these elements */
+h1, h2, h3, h4, p, li, figure {
+ margin: revert;
+}
+
+a { color: var(--text-third); }
+a:visited { color: var(--text-second); }
diff --git a/site/landing/assets/scss/single.scss b/site/landing/assets/scss/single.scss
new file mode 100644
index 0000000..49142a4
--- /dev/null
+++ b/site/landing/assets/scss/single.scss
@@ -0,0 +1,8 @@
+@import "reset";
+@import "variables";
+@import "base";
+@import "content-body";
+@import "boxes";
+@import "main-header";
+@import "scheme-toggle";
+@import "footer";
diff --git a/site/landing/content/documentation.md b/site/landing/content/documentation.md
new file mode 100644
index 0000000..a25026b
--- /dev/null
+++ b/site/landing/content/documentation.md
@@ -0,0 +1,33 @@
+---
+title: "Documentation"
+---
+
+{{< boxes >}}
+
+## Introduction to OpenTitan
+
+[OpenTitan](https://opentitan.org/) is an open source silicon Root of Trust (RoT) project. OpenTitan will make the silicon RoT design and implementation more transparent, trustworthy, and secure for enterprises, platform providers, and chip manufacturers. OpenTitan is administered by lowRISC CIC as a [collaborative project]({{< doc-url >}}doc/project_governance{{< /doc-url >}}) to produce high quality, open IP for instantiation as a full-featured product. This repository exists to enable collaboration across partners participating in the OpenTitan project.
+
+## Getting Started
+
+To get started with OpenTitan, see the [Getting Started](/guides/getting_started) page. For additional resources when working with OpenTitan, see the [contribution guide]({{< doc-url >}}doc/contributing{{< /doc-url >}}) and the [tools guide]({{< doc-url >}}util{{< /doc-url >}}). Lastly, the [Hardware book]({{< doc-url >}}hw{{< /doc-url >}}) contains technical documentation on the SoC, the Ibex processor core, and the individual IP blocks. For questions about how the project is organized, see the [project landing spot]({{< doc-url >}}doc/project_governance{{< /doc-url >}}) for more information.
+
+## Understanding OpenTitan
+
+- [Use Cases]({{< doc-url >}}doc/use_cases{{< /doc-url >}})
+- [Security]({{< doc-url >}}doc/security/{{< /doc-url >}})
+
+## Datasheets
+
+- [OpenTitan Earl Grey Chip Datasheet]({{< doc-url >}}hw/top_earlgrey/{{< /doc-url >}})
+
+## Documentation
+
+- [Hardware]({{< doc-url >}}hw{{< /doc-url >}})
+- [Software]({{< doc-url >}}sw{{< /doc-url >}})
+
+## Development
+
+- [Getting Started](/guides/getting_started)
+- [Contributing]({{< doc-url >}}doc/contributing{{< /doc-url >}})
+- [Tools]({{< doc-url >}}util{{< /doc-url >}})
diff --git a/site/landing/layouts/page/single.html b/site/landing/layouts/page/single.html
index 2749557..0c6d4b0 100644
--- a/site/landing/layouts/page/single.html
+++ b/site/landing/layouts/page/single.html
@@ -1,14 +1,32 @@
-<html>
- <head>
- {{ $options := (dict "targetPath" "css/minimal.css" "outputStyle" "compressed" "enableSourceMap" true) }}
- {{ $style := resources.Get "scss/minimal.scss" | resources.ToCSS $options }}
+<!DOCTYPE html>
+<html lang="en" class="no-js">
+
+<head>
+ {{ partial "head.html" . }}
+
+ {{ $options := (dict "targetPath" "css/single.css" "outputStyle" "compressed" "enableSourceMap" true) }}
+ {{ $style := resources.Get "scss/single.scss" | resources.ToCSS $options }}
<link rel="stylesheet" href="{{ $style.Permalink }}">
- <title>{{ .Title }} | OpenTitan</title>
- <link href="https://fonts.googleapis.com/css?family=Livvic|Ubuntu&display=swap" rel="stylesheet">
- {{ partial "gtag" . }}
- </head>
- <body>
- <h1>{{ .Title }}</h1>
- {{ .Content }}
- </body>
+</head>
+
+<body>
+ {{ partial "header.html" . }}
+
+ <main id="main" role="main" class="main-body light-bg">
+ <div class="content">
+ <h1>{{ .Title }}</h1>
+ {{ .Content }}
+ </div>
+ </main>
+
+ {{ partial "footer.html" . }}
+
+ <script src="/js/theme-changer.js"></script>
+
+ <script>
+ // Enable JS features
+ document.documentElement.classList.remove('no-js');
+ </script>
+</body>
+
</html>
diff --git a/site/landing/layouts/shortcodes/boxes.html b/site/landing/layouts/shortcodes/boxes.html
new file mode 100644
index 0000000..5488eac
--- /dev/null
+++ b/site/landing/layouts/shortcodes/boxes.html
@@ -0,0 +1,10 @@
+<div class="tiles__wrapper">
+ <div class="tiles__container">
+ <a class="tile" id="doc-qa-hw" href="/book/hw#top" title="Hardware">HW</a>
+ <a class="tile" id="doc-qa-sw" href="/book/sw#top" title="Software">SW</a>
+ <a class="tile" id="doc-qa-security" href="/book/doc/security#top" title="Security">Security</a>
+ <a class="tile" id="doc-qa-tools" href="/book/util#top" title="Tooling">Tooling</a>
+ <a class="tile" id="doc-qa-governance" href="/book/doc/project_governance#top" title="Governance">Governance</a>
+ <a class="tile" id="doc-qa-use-cases" href="/book/doc/use_cases#top" title="Use-Cases">Use-Cases</a>
+ </div>
+</div>
diff --git a/site/landing/layouts/shortcodes/doc-url.txt b/site/landing/layouts/shortcodes/doc-url.txt
new file mode 100644
index 0000000..361bff0
--- /dev/null
+++ b/site/landing/layouts/shortcodes/doc-url.txt
@@ -0,0 +1 @@
+{{ .Site.Params.docsUrl }}/{{ .Inner }}
