Skip to content

Commit 11a4a25

Browse files
authored
Merge pull request #2413 from dotnet/feature/website-3.0
[3.0] A new website for both Silk.NET 3.0 and 2.X
2 parents d7858d8 + 99d019e commit 11a4a25

File tree

119 files changed

+21670
-5807
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+21670
-5807
lines changed

.github/workflows/publish-site.yml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Website Build
2+
on:
3+
push:
4+
branches:
5+
- 'develop/3.0'
6+
pull_request:
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
jobs:
13+
Build:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Build Website
18+
run: |
19+
git submodule update --init eng/submodules/silk.net-2.x
20+
cd eng/submodules/silk.net-2.x
21+
git fetch --all
22+
cd ../../..
23+
./build.sh website
24+
env:
25+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26+
- name: Upload artifact
27+
if: ${{ github.repository == 'dotnet/Silk.NET' && github.ref == 'refs/heads/develop/3.0' }}
28+
uses: actions/upload-pages-artifact@v3
29+
with:
30+
path: "artifacts/docs/Silk.NET"
31+
Deploy:
32+
if: ${{ github.repository == 'dotnet/Silk.NET' && github.ref == 'refs/heads/develop/3.0' }}
33+
environment:
34+
name: github-pages
35+
url: ${{ steps.deployment.outputs.page_url }}
36+
runs-on: ubuntu-latest
37+
needs: Build
38+
steps:
39+
- name: Deploy to GitHub Pages
40+
id: deployment
41+
uses: actions/deploy-pages@v4

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -479,6 +479,7 @@ excluded-platforms.txt
479479
#/docs/
480480
src/Website/Silk.NET.Statiq/temp
481481
src/Website/Silk.NET.Statiq/cache
482+
.nuke/temp
482483

483484
# SilkTouch configs
484485
!eng/silktouch/**/*.rsp

.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,6 @@
1010
[submodule "eng/submodules/sdl"]
1111
path = eng/submodules/sdl
1212
url = https://github.com/libsdl-org/SDL
13+
[submodule "eng/submodules/silk.net-2.x"]
14+
path = eng/submodules/silk.net-2.x
15+
url = https://github.com/dotnet/Silk.NET

.nuke/build.schema.json

+6-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434
"PushToNuGet",
3535
"RegenerateBindings",
3636
"ShipApi",
37-
"SignPackages"
37+
"SignPackages",
38+
"Website"
3839
]
3940
},
4041
"Verbosity": {
@@ -181,6 +182,10 @@
181182
"type": "string"
182183
}
183184
},
185+
"SkipContributorsScrape": {
186+
"type": "boolean",
187+
"description": "If enabled, skips scraping the contributors for the authors.yml file of the blog"
188+
},
184189
"Solution": {
185190
"type": "string",
186191
"description": "Path to a solution file that is automatically loaded"

docs/for-contributors/README.md renamed to docs/for-contributors/README.mdx

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: "Overview"
3+
---
4+
5+
import DocCardList from '@theme/DocCardList';
6+
import { useCurrentSidebarCategory } from '@docusaurus/theme-common';
7+
18
# The Silk.NET Contributors Guide
29

310
Welcome to the Silk.NET project! We're so glad you want to help us create the best native interoperation experience that
@@ -9,9 +16,9 @@ the codebase and hit the ground running.
916
## Table of Contents
1017

1118
- [Getting Started (you are here!)](#getting-started)
19+
- [Contribution Process](../CONTRIBUTING.md)
1220
- [Build System](build-system.md)
1321

14-
1522
## Getting Started
1623

1724
### Prerequisites
@@ -55,3 +62,4 @@ where the values for the `-s` arguments are replaced with the job names (the key
5562
For more information on SilkTocuh arguments, consult the [SilkTouch User Guide](../silktouch) or use
5663
`dotnet run --project sources/SilkTouch/SilkTouch/Silk.NET.SilkTouch.csproj -- --help`.
5764

65+
<DocCardList items={useCurrentSidebarCategory().items.filter((e) => e.label != "Overview")} />

docs/for-contributors/generators/README.md

-13
This file was deleted.

docs/for-contributors/generators/emitter/README.md

-7
This file was deleted.

docs/for-contributors/generators/emitter/about formatting.md

-38
This file was deleted.

docs/for-contributors/generators/emitter/visitor.md

-39
This file was deleted.

docs/for-contributors/generators/scraper.md

-16
This file was deleted.

docs/for-contributors/generators/symbol-layer/README.md

-11
This file was deleted.

docs/for-contributors/generators/symbol-layer/symbol-visitor.md

-19
This file was deleted.

docs/for-contributors/generators/symbol-layer/symbols/README.md

-55
This file was deleted.

docs/for-contributors/generators/symbol-layer/type-references.md

-14
This file was deleted.

docs/for-contributors/generators/symbol-layer/type-store.md

-15
This file was deleted.

0 commit comments

Comments
 (0)