Skip to content

refactor(docs): Replace Sphinx doc pages with typescript pages and reorganize home page. #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AVMatthews wants to merge 3 commits into
base: main
Choose a base branch
from
Open

refactor(docs): Replace Sphinx doc pages with typescript pages and reorganize home page. #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd55c8d
reorganized new main page in TS and markdown converted to TS
AVMatthews Feb 5, 2026
bd6e86d
Merge branch 'y-scope:main' into docs-reorganization
AVMatthews Feb 5, 2026
a3c3c74
refactor and lint
AVMatthews Feb 7, 2026
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
View file
Open in desktop
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
View file
Open in desktop
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

@coderabbitai coderabbitai bot Feb 7, 2026

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 (ie → ei) 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
View file
Open in desktop
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
View file
Open in desktop
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

@coderabbitai coderabbitai bot Feb 7, 2026

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

@coderabbitai coderabbitai bot Feb 7, 2026

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
View file
Open in desktop

This file was deleted.

87 changes: 87 additions & 0 deletions docs/app/Footer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
"use client";

/**
* Footer component for the YScope Docs website.
*
* @return The rendered footer section.
*/
const Footer = () => {
return (
<footer>
<div className={"container"}>
<div className={"row"}>
<div className={"col-lg-6 mb-3"}>
<div className={"d-flex flex-row vertical-align-base"}>
<a
className={"navbar-brand logo"}
href={"https://www.yscope.com/"}
style={{
textDecoration: "none",
userSelect: "none",
fontSize: "2rem",
}}
>
YScope
</a>
<h5
style={{fontSize: "1rem", marginLeft: "0.5rem", marginTop: "1rem"}}
>
The Future of Debugging
</h5>
</div>
<div className={"col-6 text-center"}>
<a
href={"https://www.linkedin.com/company/yscope"}
rel={"noopener noreferrer"}
target={"_blank"}
>
<i className={"bi bi-linkedin"}/>
</a>
{" "}
<a
href={"https://www.youtube.com/channel/UC9y5QY1pdXcYfaYnwFuk18Q"}
rel={"noopener noreferrer"}
target={"_blank"}
>
<i className={"bi bi-youtube"}/>
</a>
{" "}
<a
href={"mailto:info@yscope.com"}
rel={"noopener noreferrer"}
target={"_blank"}
>
<i className={"bi bi-envelope"}/>
</a>
Comment on lines +33 to +55
Copy link

@coderabbitai coderabbitai bot Feb 7, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Social icon links lack accessible labels.

The LinkedIn, YouTube, and email links contain only <i> icon elements with no text or aria-label. Screen readers will announce these as empty/unnamed links, which is an accessibility blocker.

Proposed fix (example for LinkedIn) 
 <a
     href={"https://www.linkedin.com/company/yscope"}
     rel={"noopener noreferrer"}
     target={"_blank"}
+    aria-label={"LinkedIn"}
 >
     <i className={"bi bi-linkedin"}/>
 </a>

Apply similarly for YouTube and email links.

📝 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
<a
href={"https://www.linkedin.com/company/yscope"}
rel={"noopener noreferrer"}
target={"_blank"}
>
<i className={"bi bi-linkedin"}/>
</a>
{" "}
<a
href={"https://www.youtube.com/channel/UC9y5QY1pdXcYfaYnwFuk18Q"}
rel={"noopener noreferrer"}
target={"_blank"}
>
<i className={"bi bi-youtube"}/>
</a>
{" "}
<a
href={"mailto:info@yscope.com"}
rel={"noopener noreferrer"}
target={"_blank"}
>
<i className={"bi bi-envelope"}/>
</a>
<a
href={"https://www.linkedin.com/company/yscope"}
rel={"noopener noreferrer"}
target={"_blank"}
aria-label={"LinkedIn"}
>
<i className={"bi bi-linkedin"}/>
</a>
{" "}
<a
href={"https://www.youtube.com/channel/UC9y5QY1pdXcYfaYnwFuk18Q"}
rel={"noopener noreferrer"}
target={"_blank"}
aria-label={"YouTube"}
>
<i className={"bi bi-youtube"}/>
</a>
{" "}
<a
href={"mailto:info@yscope.com"}
rel={"noopener noreferrer"}
target={"_blank"}
aria-label={"Email"}
>
<i className={"bi bi-envelope"}/>
</a>
🤖 Prompt for AI Agents 
In `@docs/app/Footer.tsx` around lines 33 - 55, The social anchor elements in
Footer.tsx (the <a> tags wrapping the <i className={"bi bi-linkedin"} />, <i
className={"bi bi-youtube"} />, and <i className={"bi bi-envelope"} />) need
accessible names; update each anchor to include either an aria-label (e.g.,
aria-label="LinkedIn", "YouTube", "Email") or add visually hidden text inside
the anchor so screen readers can announce them, ensuring you keep rel and target
attributes unchanged and apply the same change to the LinkedIn, YouTube, and
mailto anchors.

</div>
</div>
<div className={"col-lg-6 text-md-end"}>
<p
style={{
color: "grey",
fontSize: "0.85rem",
paddingTop: "0.5rem",
}}
>
YScope Inc.
<br/>
W866-108 College St., Toronto,
<br/>
ON M5G 0C6, Canada.
</p>
</div>
</div>
</div>
<div className={"row"}>
<p
className={"text-center"}
style={{fontSize: "0.8rem"}}
>
Copyright © 2015-2025 YScope Inc.
</p>
Comment on lines +79 to +81
Copy link

@coderabbitai coderabbitai bot Feb 7, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Copyright year is stale.

The copyright notice reads "2015-2025" but the current year is 2026. Consider dynamically generating the end year to avoid this going stale again:

Proposed fix 
-                    Copyright © 2015-2025 YScope Inc.
+                    Copyright © 2015-{new Date().getFullYear()} YScope Inc.
📝 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
>
Copyright © 2015-2025 YScope Inc.
</p>
>
Copyright © 2015-{new Date().getFullYear()} YScope Inc.
</p>
🤖 Prompt for AI Agents 
In `@docs/app/Footer.tsx` around lines 79 - 81, The copyright year in the Footer
component is hardcoded as "2015-2025" and needs to be dynamic; update the Footer
(docs/app/Footer.tsx) so the end year is computed at runtime (e.g., const
currentYear = new Date().getFullYear()) and render "2015-{currentYear}" inside
the existing <p> element instead of the fixed "2015-2025", ensuring no other
text changes.

</div>
</footer>
);
};

export default Footer;
Loading