Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions docs/.prettyierrc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
tabWidth: 4
useTabs: false
singleQuote: false
quoteProps: consistent
printWidth: 100
endOfLine: lf
Comment on lines +1 to +6
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Filename typo: .prettyierrc.yaml should be .prettierrc.yaml.

Prettier looks for .prettierrc.yaml (among other recognized names). The transposed letters (ieei) mean this config file will be silently ignored and Prettier will fall back to its defaults.

🤖 Prompt for AI Agents
In `@docs/.prettyierrc.yaml` around lines 1 - 6, The config filename is
misspelled; rename the file from .prettyierrc.yaml to .prettierrc.yaml so
Prettier will detect and apply the settings (the content with keys like
tabWidth, singleQuote, printWidth, endOfLine should remain unchanged).

7 changes: 7 additions & 0 deletions docs/.stylelintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"extends": [
"stylelint-config-standard",
"stylelint-config-clean-order/error",
"stylelint-prettier/recommended"
]
}
50 changes: 50 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Overview

* This is a static site for https://docs.yscope.com
* We use `npm` to develop/package the static site.

# Contributing

## Requirements

Node.js via [prebuilt installers][nodejs-prebuilt-installer] / [nvm][nvm] /
[nvm-windows][nvm-windows].

## Setup

Install the project's dependencies:

```shell
npm install
```

## Running in development

You can build and serve the viewer in debug mode using:

```shell
npm run dev
```

The website should then be available at the URL by the command.
Comment on lines +23 to +29
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Minor text issues.

  • Line 23: "serve the viewer" should be "serve the site" (or "docs") — this isn't a viewer project.
  • Line 29: "available at the URL by the command" reads awkwardly; suggest "available at the URL printed by the command."
✏️ Suggested fix
-You can build and serve the viewer in debug mode using:
+You can build and serve the site in development mode using:
-The website should then be available at the URL by the command.
+The website should then be available at the URL printed by the command.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
You can build and serve the viewer in debug mode using:
```shell
npm run dev
```
The website should then be available at the URL by the command.
You can build and serve the site in development mode using:
🤖 Prompt for AI Agents
In `@docs/README.md` around lines 23 - 29, Replace the inaccurate and awkward
phrasing in the README: change "You can build and serve the viewer in debug mode
using:" to "You can build and serve the site (or docs) in debug mode using:" and
change "The website should then be available at the URL by the command." to "The
website should then be available at the URL printed by the command." Update the
two sentences in the same paragraph where they appear (the lines containing
"serve the viewer" and "available at the URL by the command") to use the
suggested replacements.


## Building a distribution

To create a build, run:

```shell
npm run build
```

The build should then be available in the `out` directory.

You can preview the build with [serve]:

```shell
npx serve out
```

[nodejs-prebuilt-installer]: https://nodejs.org/en/download/prebuilt-installer
[nvm]: https://github.com/nvm-sh/nvm
[nvm-windows]: https://github.com/coreybutler/nvm-windows
[serve]: https://www.npmjs.com/package/serve
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add a trailing newline at end of file.

Static analysis (markdownlint MD047) flags the missing final newline.

🧰 Tools
🪛 markdownlint-cli2 (0.20.0)

[warning] 50-50: Files should end with a single newline character

(MD047, single-trailing-newline)

🤖 Prompt for AI Agents
In `@docs/README.md` at line 50, The README ends with the link reference "[serve]:
https://www.npmjs.com/package/serve" but lacks a final newline; update the
docs/README.md by adding a single trailing newline character at end of file
(after the "[serve]: https://www.npmjs.com/package/serve" line) so the file
terminates with a newline and satisfies markdownlint MD047.

21 changes: 0 additions & 21 deletions docs/_static/custom.css

This file was deleted.

85 changes: 85 additions & 0 deletions docs/app/assets/css/colors.css
Original file line number Diff line number Diff line change
@@ -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;
}
Loading