Merge branch 'main' into feat/dotenv-Implement

Author: benjagm

.github/workflows/links.yml

@@ -0,0 +1,83 @@
+name: Link Checker
+
+on:
+  repository_dispatch:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 1 * *' # Run at midnight on the first of every month
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository  
+        uses: actions/checkout@v4
+
+      - name: Submodule
+        run: git submodule update --init --recursive
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install Dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Serve App Locally
+        run: yarn run dev &
+
+      - name: Wait for App to Start
+        run: sleep 20
+      
+      # This will restore the lychee cache
+      - name: Restore lychee cache
+        uses: actions/cache@v4
+        with:
+          path: .lycheecache
+          key: cache-lychee-${{ github.sha }}
+          restore-keys: cache-lychee-
+
+      # This will run the link checker on all markdown files in the pages directory      
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@v1
+        with:
+          args: --base http://localhost:3000  --verbose --no-progress --accept 200,204,429,403  './pages/**/*.md' --cache --max-cache-age 1d  http://localhost:3000 
+          token: ${{secrets.AUTH_TOKEN}}
+            
+      - name: Install Octokit
+        run: yarn add @octokit/[email protected] 
+      
+      # This will create an issue with the link checker report if it does not exist, otherwise it will update the existing issue.
+
+      - name: Create Issue
+        if:  env.lychee_exit_code != 0
+        uses: actions/github-script@v7
+        env:
+          AUTH_TOKEN: ${{secrets.AUTH_TOKEN}}
+        with:
+          script: |
+            const { Octokit } = require("@octokit/core");
+            const octokit = new Octokit({ auth: process.env.AUTH_TOKEN });
+            const allIssues = await octokit.request('GET /repos/{owner}/{repo}/issues', {
+              owner: context.repo.owner,
+              repo: context.repo.repo
+            });
+
+            const existingIssue = allIssues.data.find(issue => issue.title === 'Link Checker Report');
+            if (existingIssue) {
+              await octokit.request('PATCH /repos/{owner}/{repo}/issues/{issue_number}', {
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: existingIssue.number,
+                body: '## Link Checker Report\n\n' + require('fs').readFileSync('./lychee/out.md', 'utf8')
+              });
+            } else {
+              await octokit.request('POST /repos/{owner}/{repo}/issues', {
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                title: 'Link Checker Report',
+                body: '## Link Checker Report\n\n' + require('fs').readFileSync('./lychee/out.md', 'utf8')
+              });
+            }

.github/workflows/pr-dependencies.yml

@@ -0,0 +1,12 @@
+name: Check PR Dependencies
+
+on: pull_request
+
+jobs:
+  check_dependencies:
+    runs-on: ubuntu-latest
+    name: Check Dependencies
+    steps:
+    - uses: gregsdennis/dependencies-action@main
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

@@ -72,7 +72,12 @@ If you would like to contribute with designs, we encourage you to join `#design`
 
 We welcome pull requests for editorial suggestions and resolving open issues.
 
-If the pull request would solve a particular issue, reference the issue in the pull request description using a [supported descriptor](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) that will automatically close that issue.
+If your pull request addresses a specific issue, please reference this issue in your pull request description using a [supported descriptor](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). This helps automatically link and close the issue when the pull request is merged.
+
+We strongly encourage linking every pull request to an existing issue. If no corresponding issue exists, please create one first. This allows the community to discuss the required changes. If you are addressing an existing issue, ensure the scope is clear and consider the following:
+
+- If the issue is several years old, verify its relevance by asking in the comments.
+- Ensure the discussion within the issue has led to a clear, actionable decision.
 
 Generally, pull requests should be made to the `main` branch.
 

_includes/community

@@ -1,8 +1,13 @@
 import { useRouter } from 'next/router';
 import React, { FormEvent, useRef, useState } from 'react';
 
-export function DocsHelp() {
+interface DocsHelpProps {
+  markdownFile?: string;
+}
+
+export function DocsHelp({ markdownFile }: DocsHelpProps) {
   const router = useRouter();
+  const path = encodeURIComponent(router.pathname);
   const [isFormOpen, setIsFormOpen] = useState(false);
   const [feedbackStatus, setFeedbackStatus] = useState('');
   const [isSubmitting, setIsSubmitting] = useState(false);
@@ -214,7 +219,27 @@ export function DocsHelp() {
 
           {feedbackStatus === 'feedback' && (
             <div className='my-6 text-[14px]'>
-              <p>Thank you! We received your feedback.</p>
+              <p>
+                Thanks for the feedback! Feel free to join the&nbsp;
+                <a
+                  target='_blank'
+                  rel='noreferrer'
+                  className='underline'
+                  href='https://json-schema.slack.com/archives/C8C4UBXDF'
+                >
+                  #website
+                </a>
+                &nbsp;channel on&nbsp;
+                <a
+                  target='_blank'
+                  rel='noreferrer'
+                  className='underline'
+                  href='https://json-schema.org/slack'
+                >
+                  Slack&nbsp;
+                </a>
+                for further discussion.
+              </p>
             </div>
           )}
 
@@ -250,7 +275,7 @@ export function DocsHelp() {
               target='_blank'
               rel='noreferrer'
               className='px-[16px] py-[8px] cursor-pointer border-solid border-[#aaaaaa] border rounded-md hover:bg-gray-200 dark:hover:bg-gray-600'
-              href='https://github.com/orgs/json-schema-org/projects/16'
+              href={`https://github.com/json-schema-org/website/blob/main/pages${markdownFile ? (markdownFile === '_indexPage' ? router.asPath + '/_index.md' : router.asPath + '.md') : `/${path}/index.page.tsx`}`}
             >
               <svg
                 className='inline-block select-none align-text-bottom mr-1'
@@ -263,7 +288,7 @@ export function DocsHelp() {
               >
                 <path d='M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z' />
               </svg>
-              Make a contribution
+              Edit this page on Github
             </a>
           </div>
           <div className='my-2 text-[14px]'>

components/DocsHelp.tsx

@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { useState, useEffect } from 'react';
 import classnames from 'classnames';
 import slugifyMarkdownHeadline from '~/lib/slugifyMarkdownHeadline';
 import { useRouter } from 'next/router';
@@ -40,33 +40,46 @@ const Headline = ({
   attributes?: Record<string, any>;
 }) => {
   const router = useRouter();
+  const [isActive, setIsActive] = useState<boolean>(false);
   const asPath = router.asPath;
   const slug = slugifyMarkdownHeadline(children as any[]);
 
+  useEffect(() => {
+    const hashIndex = asPath.indexOf('#');
+    const slugFromPath = hashIndex !== -1 ? asPath.slice(hashIndex + 1) : null;
+
+    setIsActive(slug === slugFromPath);
+  }, [router.asPath]);
+
+  const handleHeadingClick = () => {
+    const url = new URL(asPath, HOST);
+    const newHash = `#${slug}`;
+    url.hash = newHash;
+
+    const urlString = url.toString().substr(HOST.length, Infinity);
+    router.push(urlString, undefined, { shallow: true });
+    setIsActive(true);
+  };
+
   const attributes = {
     ...propAttributes,
     id: propAttributes?.slug || slug,
     className: classnames(
       'group cursor-pointer hover:underline',
+      { 'text-startBlue dark:text-endBlue': isActive },
       propAttributes?.className,
     ),
-    onClick: () => {
-      const url = new URL(asPath, HOST);
-      // recalculation necessary because of scope issue
-      const slug = slugifyMarkdownHeadline(children as any[]);
-      url.hash = `#${slug}`;
-
-      const urlString = url.toString().substr(HOST.length, Infinity);
-      window.location.href = urlString;
-    },
+    onClick: handleHeadingClick,
   };
   const childredWithoutFragment = filterFragment(children);
   return (
     <Tag attributes={attributes}>
       {childredWithoutFragment}
-      <span className='text-slate-300 inline-block ml-2 opacity-0 group-hover:opacity-100'>
-        ¶
-      </span>
+      {isActive && (
+        <span className={'text-startBlue dark:text-endBlue inline-block ml-2'}>
+          ¶
+        </span>
+      )}
     </Tag>
   );
 };