Website rework (duplicated) #2171

lumi2021 · 2024-05-09T00:55:47Z

The Silk.NET website remade from scratch

As requested by Perksey, it now is build on Docusaurus. It style is completely made from scratch based on the current one (without templates this time 💀)

I'm sending only the source code. To generate the build folder just run npm run build. build/ isn't on .gitignore because i suppose this folder is required to serve the application.

As Docusaurus uses an routing system, it will generate 2 folders on build directory. an Client an an Server. I don't know how to solve the server problem and i expect another one can solve this issue (sry for delegate work).

Some links may and WILL broke, it's proposal because i don't know the right routes until the compilation and setup of the website. When everything is ok i will back on it and resolve these links.

Here, a link of the source code on stackblitz. As it have full compatibility with Docusaurus, it's just open and wait to see a working preview. Try to explore the entire site and test responsivities because some things can change.

unfortunately, Docusaurus uses git history information to set doc page's author, so I'm the author of everything now lol. It can be solved only if the respective authors do some changes on their .md files.

Any issues, questions or anything, pls comment here

_{Perksey-senpai pls accept my PR 👉👈😖}

Perksey · 2024-05-26T16:24:00Z

Yeah I have no idea how to build this so I can't review it. Can you maybe add something to NUKE so I can just do ./build.sh website? This should help CI integration as well.

Perksey · 2024-05-26T16:24:18Z

Ah helps if I read, but yeah a NUKE job would be helpful.

Perksey · 2024-05-26T16:28:00Z

Build fails locally.



[ERROR] Error: Unable to build website for locale en.
    at tryToBuildLocale (/Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/core/lib/commands/build.js:53:19)
    at async /Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/core/lib/commands/build.js:64:9
    at async mapAsyncSequential (/Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/utils/lib/jsUtils.js:20:24)
    at async Command.build (/Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/core/lib/commands/build.js:62:5) {
  [cause]: Error: Docusaurus found broken links!
  
  Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
  Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.
  
  It looks like some of the broken links we found appear in many pages of your site.
  Maybe those broken links appear on all pages through your site layout?
  We recommend that you check your theme configuration for such links (particularly, theme navbar and footer).
  Frequent broken links are linking to:
  - /Silk.NET/blog
  
  Exhaustive list of all broken links found:
  - Broken link on source page path = /Silk.NET/404.html:
     -> linking to /Silk.NET/blog
  - Broken link on source page path = /Silk.NET/docs/getStarted:
     -> linking to /Silk.NET/blog
  - Broken link on source page path = /Silk.NET/docs/HLU/HluTutorials:
     -> linking to /Silk.NET/blog
  - Broken link on source page path = /Silk.NET/docs/HLU/troubleshoting:
     -> linking to /Silk.NET/blog
  - Broken link on source page path = /Silk.NET/docs/opengl/helloQuad:
     -> linking to /Silk.NET/blog
     -> linking to ../sources/1.2.7-finished-setup.html (resolved as: /Silk.NET/docs/sources/1.2.7-finished-setup.html)
     -> linking to ../sources/1.2-final-result.html (resolved as: /Silk.NET/docs/sources/1.2-final-result.html)
  - Broken link on source page path = /Silk.NET/docs/opengl/helloTexture:
     -> linking to /Silk.NET/blog
     -> linking to ../sources/1.3-final-result.html (resolved as: /Silk.NET/docs/sources/1.3-final-result.html)
  - Broken link on source page path = /Silk.NET/docs/opengl/helloWindow:
     -> linking to /Silk.NET/blog
  - Broken link on source page path = /Silk.NET/:
     -> linking to /Silk.NET/blog
  
      at throwError (/Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/logger/lib/index.js:79:11)
      at reportBrokenLinks (/Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/core/lib/server/brokenLinks.js:242:47)
      at handleBrokenLinks (/Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/core/lib/server/brokenLinks.js:274:5)
      at executeBrokenLinksCheck (/Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/core/lib/commands/build.js:182:47)
      at /Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/core/lib/commands/build.js:136:66
      at Object.async (/Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/core/lib/utils.js:36:47)
      at buildLocale (/Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/core/lib/commands/build.js:136:30)
      at async tryToBuildLocale (/Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/core/lib/commands/build.js:46:13)
      at async /Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/core/lib/commands/build.js:64:9
      at async mapAsyncSequential (/Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/utils/lib/jsUtils.js:20:24)
      at async Command.build (/Users/dylan/Documents/Silk.NET/website/node_modules/@docusaurus/core/lib/commands/build.js:62:5)
}

Perksey · 2024-05-26T16:28:35Z

Btw can you make sure the URL paths are the same in the new site as the old site? i.e. each page is located at the same URL? Always frustrating when websites break this, and I try to avoid this where possible.

Perksey

As above

lumi2021 · 2024-05-28T18:14:21Z

Yeah I have no idea how to build this so I can't review it. Can you maybe add something to NUKE so I can just do ./build.sh website? This should help CI integration as well.

i will try to do it

lumi2021 · 2024-05-28T18:20:43Z

Btw can you make sure the URL paths are the same in the new site as the old site? i.e. each page is located at the same URL? Always frustrating when websites break this, and I try to avoid this where possible.

unfortunately I can't do it, as the old website was being made with static files
https://domain/Silk.NET/index.html
and docusaurus use routing
https://domain/Silk.NET

but i can try match 100% the routes with the static files directories if they are still not matching

lumi2021 · 2024-06-24T05:49:54Z

Build fails locally.
...
@Perksey

Rly sorry for the time gap, but now I'm back to review it. This is occurring because of an option on the ./docusaurus.config.js file, where a field called onBrokenLinks says that it's for abort the running and throws an error when a broken link is found.
To fix this security behavior during running tests, just find the property and change the value to something that will not cause the compilation to be aborted, like ignore or anything different that what's setted rn. I'm on mobile so I can't give more clarified details, but you can find exactly what you need to do here
https://docusaurus.io/docs/api/docusaurus-config#onBrokenLinks

Perksey · 2024-06-24T14:48:54Z

I am not interested in reviewing a PR where the reviewer has to do work to get it into a mergeable state.

lumi2021 · 2024-06-26T10:46:32Z

I am not interested in reviewing a PR where the reviewer has to do work to get it into a mergeable state.
@Perksey

Sry, i will try to fix the conflicts

fixing conflicts

lumi2021 · 2024-06-27T14:36:30Z

@Perksey

All conflicts are fixed now
Also I added the build commands. Idk if it's on the way that you wanted, but it's working

Also, do you already saw the website at runtime?

Perksey · 2024-07-07T20:47:33Z

Wasn't quite what I was after

dylan@Mac Silk.NET % ./build.sh website 
GNU bash, version 5.2.26(1)-release (aarch64-apple-darwin23.2.0)
Microsoft (R) .NET Core SDK version 7.0.404
15:37:56 [WRN] Solution /Users/dylan/Downloads/Silk.NET/Silk.NET.sln has active build configurations for the build project.
Either enable SuppressBuildProjectCheck on Build.OriginalSolution or remove the following entries from the solution file:
  - {B9A8D738-FE7D-4860-A446-4A03E3DDEB74}.Debug|Any CPU.Build.0 = Debug|Any CPU
  - {B9A8D738-FE7D-4860-A446-4A03E3DDEB74}.Debug|x64.Build.0 = Debug|Any CPU
  - {B9A8D738-FE7D-4860-A446-4A03E3DDEB74}.Debug|x86.Build.0 = Debug|Any CPU
  - {B9A8D738-FE7D-4860-A446-4A03E3DDEB74}.Release|x64.Build.0 = Release|Any CPU
  - {B9A8D738-FE7D-4860-A446-4A03E3DDEB74}.Release|x86.Build.0 = Release|Any CPU

███╗   ██╗██╗   ██╗██╗  ██╗███████╗
████╗  ██║██║   ██║██║ ██╔╝██╔════╝
██╔██╗ ██║██║   ██║█████╔╝ █████╗  
██║╚██╗██║██║   ██║██╔═██╗ ██╔══╝  
██║ ╚████║╚██████╔╝██║  ██╗███████╗
╚═╝  ╚═══╝ ╚═════╝ ╚═╝  ╚═╝╚══════╝

NUKE Execution Engine version 6.3.0 (OSX,.NETCoreApp,Version=v7.0)

Target with name 'website' does not exist. Available targets are:
  - Assimp
  - BuildLibSilkDroid
  - Clean
  - Compile
  - DeclareApi
  - Dxvk
  - EnsureApiDeclared
  - FullCompile
  - FullPack
  - FullPushToNuGet
  - GLFW
  - MoltenVK
  - OpenALSoft
  - Pack
  - Prerequisites
  - PushToNuGet
  - RegenerateBindings
  - Restore
  - SDL2
  - Shaderc
  - ShipApi
  - SignPackages
  - Sln
  - SPIRVCross
  - SPIRVReflect
  - SwiftShader
  - Test
  - ValidateSolution
  - Vkd3d
  - VulkanLoader
  - Wgpu

And your non-NUKE script (which wasn't what was asked for) doesn't work:

dylan@Mac website % ./build.sh
GNU bash, version 5.2.26(1)-release (aarch64-apple-darwin23.2.0)
./build.sh: line 16: syntax error near unexpected token `}'

I did manage to build it and will base my review on that, but note that in order to be accepted the website GitHub workflow needs to be able to run (test it on your own fork) and be able to run in GitHub Pages. Will review now.

Perksey · 2024-07-07T20:47:59Z

documentation/proposals/Proposal - Multi-Backend Input.md

+public readonly record struct ConnectionEvent(IInputDevice Device, DateTimeOffset? Timestamp, bool IsConnected);
+public readonly record struct KeyDownEvent(IKeyboard Keyboard, DateTimeOffset? Timestamp, Key Key, bool IsRepeat);
+public readonly record struct KeyUpEvent(IKeyboard Keyboard, DateTimeOffset? Timestamp, Key Key);
+public readonly record struct KeyCharEvent(IKeyboard Keyboard, DateTimeOffset? Timestamp, char Character);
+public readonly record struct MouseDownEvent(IMouse Mouse, DateTimeOffset? Timestamp, Vector2 Position, MouseButton Button);
+public readonly record struct MouseUpEvent(IMouse Mouse, DateTimeOffset? Timestamp, Vector2 Position, MouseButton Button);
+public readonly record struct MouseMoveEvent(IMouse Mouse, DateTimeOffset? Timestamp, Vector2 Position, Vector2 Delta);
+public readonly record struct MouseScrollEvent(IMouse Mouse, DateTimeOffset? Timestamp, Vector2 Position, Vector2 WheelPosition, Vector2 Delta);
+public readonly record struct MouseClickEvent(IMouse Mouse, DateTimeOffset? Timestamp, Vector2 Position, MouseButton Button);
+public readonly record struct JoystickDownEvent(IJoystick Joystick, DateTimeOffset? Timestamp, JoystickButton Button);
+public readonly record struct JoystickUpEvent(IJoystick Joystick, DateTimeOffset? Timestamp, JoystickButton Button);
+public readonly record struct JoystickHatMoveEvent(IJoystick Joystick, DateTimeOffset? Timestamp, Vector2 Value, Vector2 Delta);
+public readonly record struct JoystickAxisMoveEvent(IJoystick Joystick, DateTimeOffset? Timestamp, int Axis, float Value, float Delta);
+public readonly record struct GamepadDownEvent(IGamepad Gamepad, DateTimeOffset? Timestamp, JoystickButton Button);
+public readonly record struct GamepadUpEvent(IGamepad Gamepad, DateTimeOffset? Timestamp, JoystickButton Button);
+public readonly record struct GamepadThumbstickMoveEvent(IJoystick Joystick, DateTimeOffset? Timestamp, Vector2 Value, Vector2 Delta);
+public readonly record struct GamepadTriggerMoveEvent(IJoystick Joystick, DateTimeOffset? Timestamp, int Axis, float Value, float Delta);


Why has this changed in this PR?

I have no idea...
will try to understand and revert

Perksey · 2024-07-07T20:48:30Z

website/build.cmd

+:; set -eo pipefail
+:; SCRIPT_DIR=$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd)
+:; ${SCRIPT_DIR}/build.sh "$@"
+:; exit $?
+
+@ECHO OFF
+powershell -ExecutionPolicy ByPass -NoProfile -File "%~dp0build.ps1" %*


Remove these scripts, automation should be in NUKE instead. Don't want loads of random build scripts in multiple places in the repo.

I tried to make the website more scope closed, but if you don't want it's fine, i will implement the NUKE script in the root

Perksey · 2024-07-07T20:53:04Z

website/docs/HLU/HluTutorials.md

+# HLU Tutorials
+
+We're still working on our Windowing &amp; Input High Level Utilities (HLU) tutorials!
+
+You can get the gist of how HLU works by reading through the [OpenGL tutorials](/docs/opengl/helloWindow)


Docusaurus seemingly has the ability to have a parent have content in its own right e.g. see https://docusaurus.io/docs/migration and how when you click on "Upgrading" it has its own content, with the specific guides as pages in their own right.

This is meant to be a landing page i.e. when I click on "HLU" I want this page to show up, I don't want this to be its own entry in the menu bar.

This way we can likely preserve the URL, too i.e. this page is docs/hlu

Perksey · 2024-07-07T20:53:19Z

website/docs/HLU/HluTutorials.md

@@ -0,0 +1,5 @@
+# HLU Tutorials


Can you change this directory name to have no capitals.

Perksey · 2024-07-07T20:54:09Z

website/docs/HLU/troubleshoting.md

+**Ensure you have the [Microsoft Visual C++ Redisributables](https://docs.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170) installed!**
+
+**Ensure the underlying API is present on the system**


Why has this been reformatted?

Perksey · 2024-07-07T21:21:37Z

website/src/components/mainPage/AllInOneSolution/AllinOneSolution.tsx

+            <img src={'img/xplatpromo.png'} draggable={"false"}></img>
+
+            <div className={styles.item}>
+                <span><FontAwesomeIcon icon={faTrowelBricks}></FontAwesomeIcon></span>


Can this be a cog icon please

Perksey · 2024-07-07T21:24:34Z

website/src/components/mainPage/JoinConversation/joinConversation.tsx

+
+                        <p>Active and fun community;</p>
+                        <p>Quick answers and <span className={styles.channelLink}>help</span> channel;</p>
+                        <p>News and announcements</p>


Suggested change

Active and fun community;

Quick answers and help channel;

News and announcements

Active community

Easy & quick answers to questions

News and announcements

Perksey · 2024-07-07T21:26:21Z

website/src/components/mainPage/JoinConversation/joinConversation.tsx

+                    <div className={styles.content}>
+                        <p>Contribute with:</p>
+                        <div className={styles.list}>
+                            <p>💡 ideas;</p>
+                            <p>⏫ suggestions;</p>
+                            <p>🐞 bug reports;</p>
+                        </div>
+                        <p>
+                            And the future of Silk.NET directly with the
+                            .NET team!
+                        </p>


Suggested change

<div className={styles.content}>

Contribute with:

<div className={styles.list}>

💡 ideas;

⏫ suggestions;

🐞 bug reports;

</div>



And the future of Silk.NET directly with the

.NET team!



<div className={styles.content}>



Get answers to your questions, and participate in the development by discussing and/or contributing improvements.



(or something along those lines)

Perksey · 2024-07-07T21:28:30Z

website/docusaurus.config.js

+
+  favicon: 'img/favicon.ico',
+
+  organizationName: 'dotnet comunity',


.NET Foundation

Perksey · 2024-07-07T21:32:27Z

website/src/pages/index.module.css

+html[data-theme='dark'] {
+  --ifm-background-color: #3B4252;
+  --ifm-hero-background-color: #2E3440;
+}
+html[data-theme='light'] {
+  --ifm-background-color: white;
+  --ifm-hero-background-color: whitesmoke;
+}


If you're applying the Nord colour palette can you please do so consistently. Here are all of the colours (i.e. darker tones to use instead of the defaults to contrast against the background)

Also can you make sure we're using purple accents instead of the default green?

i will try to replace all the green colors that i've missed

Perksey · 2024-07-07T21:34:19Z

Oh also where has the miscellaneous section gone (and the FAQ link in the navbar) - can we add this back please

lumi2021 added 3 commits February 20, 2024 18:44

first commit

91d3a55

perksey recommended changes and some updates

4f4fd86

Silk.NET website rewrote from scratch to docusaurus

7957aae

lumi2021 requested a review from a team as a code owner May 9, 2024 00:55

Perksey requested changes May 26, 2024

View reviewed changes

lumi2021 added 6 commits June 26, 2024 09:10

easy command line building system

1b73efa

easy command line building system 2

073d550

gitignore update

2fc16df

Merge branch 'main' of https://github.com/dotnet/Silk.NET

a90f947

Merge branch 'website-rework'

9bcca97

Merge pull request #2 from lumi2021/main

43c56bb

fixing conflicts

Perksey requested changes Jul 7, 2024

View reviewed changes

lumi2021 closed this Jul 29, 2024

lumi2021 changed the title ~~Website rework~~ Website rework (duplicated) Aug 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Website rework (duplicated) #2171

Website rework (duplicated) #2171

lumi2021 commented May 9, 2024

Perksey commented May 26, 2024

Perksey commented May 26, 2024

Perksey commented May 26, 2024

Perksey commented May 26, 2024

Perksey left a comment

lumi2021 commented May 28, 2024

lumi2021 commented May 28, 2024 •

edited

Loading

lumi2021 commented Jun 24, 2024 •

edited

Loading

Perksey commented Jun 24, 2024

lumi2021 commented Jun 26, 2024 •

edited

Loading

lumi2021 commented Jun 27, 2024

Perksey commented Jul 7, 2024

Perksey Jul 7, 2024

lumi2021 Jul 8, 2024

Perksey Jul 7, 2024

lumi2021 Jul 8, 2024

Perksey Jul 7, 2024

Perksey Jul 7, 2024

Perksey Jul 7, 2024

Perksey Jul 7, 2024

Perksey Jul 7, 2024

Perksey Jul 7, 2024

Perksey Jul 7, 2024

Perksey Jul 7, 2024

lumi2021 Jul 8, 2024 •

edited

Loading

Perksey commented Jul 7, 2024

		Ensure you have the [Microsoft Visual C++ Redisributables](https://docs.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170) installed!

		Ensure the underlying API is present on the system


		favicon: 'img/favicon.ico',

		organizationName: 'dotnet comunity',

Website rework (duplicated) #2171

Website rework (duplicated) #2171

Conversation

lumi2021 commented May 9, 2024

The Silk.NET website remade from scratch

Perksey commented May 26, 2024

Perksey commented May 26, 2024

Perksey commented May 26, 2024

Perksey commented May 26, 2024

Perksey left a comment

Choose a reason for hiding this comment

lumi2021 commented May 28, 2024

lumi2021 commented May 28, 2024 • edited Loading

lumi2021 commented Jun 24, 2024 • edited Loading

Perksey commented Jun 24, 2024

lumi2021 commented Jun 26, 2024 • edited Loading

lumi2021 commented Jun 27, 2024

Perksey commented Jul 7, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lumi2021 Jul 8, 2024 • edited Loading

Choose a reason for hiding this comment

Perksey commented Jul 7, 2024

lumi2021 commented May 28, 2024 •

edited

Loading

lumi2021 commented Jun 24, 2024 •

edited

Loading

lumi2021 commented Jun 26, 2024 •

edited

Loading

lumi2021 Jul 8, 2024 •

edited

Loading