feat: Add Next.js-based homepage for easier navigation and nest the Sphinx-based developer docs.

README.md

@@ -15,6 +15,12 @@ Follow the steps below to build and view the site locally.
 
 ## Building
 
+* Clone any submodules:
+
+  ```shell
+  git submodule update --init --recursive
+  ```
+
 * Build the site incrementally:
 
   ```shell

docs/conf.py → docs/dev-docs/conf.py

@@ -8,7 +8,7 @@
 
 project = "YScope"
 # NOTE: We don't include a period after "Inc" since the theme adds one already.
-project_copyright = "2023-2024 YScope Inc"
+project_copyright = "2023-2026 YScope Inc"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/dev-docs/dev-guide/index.md

@@ -0,0 +1,32 @@
+# Developer Guide
+
+This section contains docs describing our development practices such as coding guidelines, and the
+like. [Contributions](#contributing) are welcome!
+
+:::{toctree}
+:caption: Contribution guidelines
+:maxdepth: 1
+
+contrib-guides-overview
+contrib-guides-general
+contrib-guides-cpp
+contrib-guides-taskfiles
+:::
+
+:::{toctree}
+:caption: Misc
+:maxdepth: 1
+
+misc-deploying
+misc-project-docs
+:::
+::::
+
+(contributing)=
+## Contributing
+
+To edit existing docs, click the "{fas}`pencil` Edit on GitHub" link found in the right sidebar of
+the page you want to edit. To create new docs, go to the relevant project's repo and add pages
+to the `docs` folder. The repo for this documentation hub is [here][yscope-docs].
+
+[yscope-docs]: https://github.com/y-scope/yscope-docs

docs/dev-docs/dev-guide/misc-project-docs.md

@@ -0,0 +1,40 @@
+# Project docs
+
+Below are links to our open-source projects that have dedicated documentation (so far).
+
+::::{grid} 1 1 2 2
+:gutter: 2
+
+:::{grid-item-card}
+:link: /clp/main
+CLP (clp)
+^^^
+A tool that can compress both text and JSON logs with higher compression than general-purpose
+compressors while allowing search without full decompression. CLP can run as a large distributed
+system and includes a UI.
+:::
+
+:::{grid-item-card}
+:link: /clp-ffi-py/main
+clp-ffi-py
+^^^
+A Python library exposing an interface to CLP's core. It currently supports serializing,
+deserializing, searching, and analyzing CLP IR files.
+:::
+
+:::{grid-item-card}
+:link: /yscope-log-viewer/main
+YScope Log Viewer (yscope-log-viewer)
+^^^
+A web interface for viewing logs that use CLP’s IR stream format including features like filtering
+by log level and viewing large files.
+:::
+
+:::{grid-item-card}
+:link: /log-surgeon/main
+Log Surgeon (log-surgeon)
+^^^
+A customizable library for parsing logs efficiently and with high performance compared to
+general-purpose regular expression engines.
+:::
+::::

docs/dev-docs/index.rst

@@ -0,0 +1,4 @@
+.. toctree::
+   :hidden:
+
+   dev-guide/index

docs/homepage/.gitignore

@@ -0,0 +1,45 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+/public/robots.txt
+/public/sitemap.xml
+/public/sitemap-*.xml
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# env files (can opt-in for committing if needed)
+.env*
+!.env.example
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

docs/homepage/.prettierrc.yaml

@@ -0,0 +1,6 @@
+tabWidth: 4
+useTabs: false
+singleQuote: false
+quoteProps: consistent
+printWidth: 100
+endOfLine: lf

docs/homepage/.stylelintrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": [
+    "stylelint-config-standard",
+    "stylelint-config-clean-order/error",
+    "stylelint-prettier/recommended"
+  ]
+}

docs/homepage/app/assets/css/colors.css

@@ -0,0 +1,85 @@
+/* CSS variables exported from Tailwind color config */
+:root {
+  --white: #ffffff;
+  --black: #000000;
+
+  --light-bg: #ffffff;
+  --dark-bg: #16181b;
+
+  --light-bg-alt: #efefef;
+  --dark-bg-alt: #111315;
+
+  /* Brilliant Azure */
+  --brilliant-azure: #1888FA;
+  --brilliant-azure-50: #e6f2fe;
+  --brilliant-azure-100: #cde5fe;
+  --brilliant-azure-150: #b5d9fd;
+  --brilliant-azure-200: #9bccfd;
+  --brilliant-azure-300: #69b2fc;
+  --brilliant-azure-400: #3799fb;
+  --brilliant-azure-500: #057ffa;
+  --brilliant-azure-550: #0573e1;
+  --brilliant-azure-600: #0466c8;
+  --brilliant-azure-700: #034c96;
+  --brilliant-azure-800: #023364;
+  --brilliant-azure-850: #02264B;
+  --brilliant-azure-900: #011932;
+  --brilliant-azure-950: #011223;
+
+  /* Turquoise */
+  --turquoise: #62D6BF;
+  --turquoise-50: #ebfaf7;
+  --turquoise-100: #d6f5ef;
+  --turquoise-200: #aeeade;
+  --turquoise-300: #85e0ce;
+  --turquoise-400: #5dd5bd;
+  --turquoise-500: #34cbad;
+  --turquoise-600: #2aa28a;
+  --turquoise-700: #18786f;
+  --turquoise-800: #094f4d;
+  --turquoise-850: #043C3B;
+  --turquoise-900: #002928;
+  --turquoise-950: #001e1d;
+
+  /* Space Indigo */
+  --space-indigo: #201E50;
+  --space-indigo-50: #ededf8;
+  --space-indigo-100: #dbdaf1;
+  --space-indigo-200: #b7b5e3;
+  --space-indigo-300: #9290d5;
+  --space-indigo-400: #6e6bc7;
+  --space-indigo-500: #4a46b9;
+  --space-indigo-600: #3b3894;
+  --space-indigo-700: #2c2a6f;
+  --space-indigo-800: #1e1c4a;
+  --space-indigo-900: #0f0e25;
+  --space-indigo-950: #0a0a1a;
+
+  /* Dark Spruce */
+  --dark-spruce: #2C5530;
+  --dark-spruce-50: #eef6ef;
+  --dark-spruce-100: #ddeedf;
+  --dark-spruce-200: #bcdcbf;
+  --dark-spruce-300: #9acb9f;
+  --dark-spruce-400: #78ba7f;
+  --dark-spruce-500: #57a85f;
+  --dark-spruce-600: #45874c;
+  --dark-spruce-700: #346539;
+  --dark-spruce-800: #234326;
+  --dark-spruce-900: #112213;
+  --dark-spruce-950: #0c180d;
+
+  /* Tuscan Sun */
+  --tuscan-sun: #F7C548;
+  --tuscan-sun-50: #fef7e7;
+  --tuscan-sun-100: #fdf0ce;
+  --tuscan-sun-200: #fbe09d;
+  --tuscan-sun-300: #f9d16c;
+  --tuscan-sun-400: #f7c23b;
+  --tuscan-sun-500: #f5b20a;
+  --tuscan-sun-600: #c48f08;
+  --tuscan-sun-700: #936b06;
+  --tuscan-sun-800: #624704;
+  --tuscan-sun-900: #312402;
+  --tuscan-sun-950: #221901;
+}