More site work

Author: Perksey

docs/for-contributors/README.mdx

@@ -3,6 +3,7 @@ title: "Overview"
 ---
 
 import DocCardList from '@theme/DocCardList';
+import { useCurrentSidebarCategory } from '@docusaurus/theme-common';
 
 # The Silk.NET Contributors Guide
 
@@ -61,4 +62,4 @@ where the values for the `-s` arguments are replaced with the job names (the key
 For more information on SilkTocuh arguments, consult the [SilkTouch User Guide](../silktouch) or use
 `dotnet run --project sources/SilkTouch/SilkTouch/Silk.NET.SilkTouch.csproj -- --help`.
 
-<DocCardList />
+<DocCardList items={useCurrentSidebarCategory().items.filter((e) => e.label != "Overview")} />

docs/index.mdx

@@ -71,7 +71,7 @@ jumping-off point for new users to Silk.NET - regardless of whether you've used
 or you've never seen anything about it before! To that end, you can find our own documentation indexed below or
 throughout this site.
 
-<DocCardList items={useDocsSidebar().items} />
+<DocCardList items={useDocsSidebar().items.filter((e) => e.label != "Welcome")} />
 
 Have fun! We always look forward to seeing what people can create with Silk.NET and would love to hear how you get on in
 our Discord server.

docs/vulkan/structure-chaining/overview.md

@@ -109,7 +109,7 @@ If you are creating a chain once, and then throwing it away, it can be done so s
 create never leave the stack. Silk.NET provides fluent extension methods that allow you to manipulate `IChainable`
 structures directly, performing the pointer logic for you, and providing compile-time type validation. Although,
 avoiding the heap entirely, there are some scenarios where this may still be slower than
-using [Managed Chains](managed-chains.md), and so this approach should only be considered when looking to optimise hot
+using [Managed Chains](managed-chaining.md), and so this approach should only be considered when looking to optimise hot
 paths. For example:
 
 ```csharp

docs/vulkan/structure-chaining/raw_chaining.md

@@ -15,7 +15,7 @@ API.
 
 The easiest way to prevent pointers moving is to ensure that structures are created and used locally in the same
 function. This ensures that they remain in the current stack frame, preventing the runtime from moving any data.
-Sometimes, it is desirable to store structures for later use, in which case [Managed Chaining](managed-chains.md) should
+Sometimes, it is desirable to store structures for later use, in which case [Managed Chaining](managed-chaining.md) should
 be considered.
 
 Each structure defines a constructor which accepts the fields as parameters and specifies defaults, including the
@@ -83,4 +83,4 @@ than either of the other two methodologies, depending on the exact use case. In
 if the chain ends up be passed around and copy operations are triggerred inadvertently on larger structures. For this
 reason, it is usually better to start with [Managed Chaining](managed-chaining.md), and optimise hot paths were
 necessary, using benchmarking to validate results. Starting with one of the other two approaches will usually make it
-easier to validate chain types, and improve compile time checking during development.
+easier to validate chain types, and improve compile time checking during development.

sources/Website/docusaurus.config.ts

@@ -2,9 +2,45 @@ import {themes as prismThemes} from 'prism-react-renderer';
 import type {Config} from '@docusaurus/types';
 import type * as Preset from '@docusaurus/preset-classic';
 import remarkGithubAdmonitionsToDirectives from "remark-github-admonitions-to-directives";
+import { visit } from 'unist-util-visit';
+import { pathToFileURL } from 'node:url';
+import path from 'node:path';
 
 // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
 
+const ABS_URL_REGEX = /^[a-zA-Z][a-zA-Z\d+\-.]*?:/;
+function isAbsolute(url) {
+    return path.isAbsolute(url) || ABS_URL_REGEX.test(url);
+}
+
+const rewriteSourceLinks = (options) => {
+    const transformer = async (ast, vfile) => {
+        let fileDirPath = path.resolve(path.dirname(vfile.path));
+        let repoRoot = path.resolve("../../");
+        let docsRoot = path.join(repoRoot, "docs");
+        let silk2Src = path.join(repoRoot, "src");
+        visit(ast, 'link', (node) => {
+            if (isAbsolute(node.url)) {
+                return;
+            }
+            let resolvedUrlPath = path.join(fileDirPath, node.url);
+            console.log(resolvedUrlPath + " - " + node.url + " - " + fileDirPath);
+            if (!path.relative(resolvedUrlPath, docsRoot).startsWith("..")) {
+                return;
+            }
+            let silk2Rel = path.relative(resolvedUrlPath, silk2Src);
+            if (!silk2Rel.startsWith("..")) {
+                node.url = `https://github.com/dotnet/Silk.NET/blob/main/src/${silk2Rel}`
+            }
+            let silk3Rel = path.relative(resolvedUrlPath, repoRoot);
+            if (!silk3Rel.startsWith("..")) {
+                node.url = `https://github.com/dotnet/Silk.NET/blob/develop/3.0/${silk3Rel}`
+            }
+        });
+    };
+    return transformer;
+};
+
 const config: Config = {
     title: 'Silk.NET',
     tagline: 'Your one-stop-shop for high performance .NET graphics & compute.',
@@ -46,7 +82,10 @@ const config: Config = {
                     // editUrl:
                     //     'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
                     exclude: ["README.md"],
-                    beforeDefaultRemarkPlugins: [remarkGithubAdmonitionsToDirectives],
+                    beforeDefaultRemarkPlugins: [
+                        remarkGithubAdmonitionsToDirectives,
+                        rewriteSourceLinks
+                    ],
                 },
                 blog: {
                     showReadingTime: true,

sources/Website/package-lock.json

@@ -23,7 +23,8 @@
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
     "react-responsive-3d-carousel": "^2.1.1",
-    "remark-github-admonitions-to-directives": "^2.1.0"
+    "remark-github-admonitions-to-directives": "^2.1.0",
+    "unist-util-visit": "^5.0.0"
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "3.6.3",