Skip to content
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.

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

[3.0] A new website for both Silk.NET 3.0 and 2.X #2413

Merged
merged 25 commits into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
41 changes: 41 additions & 0 deletions .github/workflows/publish-site.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Website Build
on:
push:
branches:
- 'develop/3.0'
pull_request:
permissions:
contents: read
pages: write
id-token: write

jobs:
Build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Build Website
run: |
git submodule update --init eng/submodules/silk.net-2.x
cd eng/submodules/silk.net-2.x
git fetch --all
cd ../../..
./build.sh website
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Upload artifact
if: ${{ github.repository == 'dotnet/Silk.NET' && github.ref == 'refs/heads/develop/3.0' }}
uses: actions/upload-pages-artifact@v3
with:
path: "artifacts/docs/Silk.NET"
Deploy:
if: ${{ github.repository == 'dotnet/Silk.NET' && github.ref == 'refs/heads/develop/3.0' }}
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: Build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -479,6 +479,7 @@ excluded-platforms.txt
#/docs/
src/Website/Silk.NET.Statiq/temp
src/Website/Silk.NET.Statiq/cache
.nuke/temp

# SilkTouch configs
!eng/silktouch/**/*.rsp
Expand Down
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,6 @@
[submodule "eng/submodules/sdl"]
path = eng/submodules/sdl
url = https://github.com/libsdl-org/SDL
[submodule "eng/submodules/silk.net-2.x"]
path = eng/submodules/silk.net-2.x
url = https://github.com/dotnet/Silk.NET
7 changes: 6 additions & 1 deletion .nuke/build.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@
"PushToNuGet",
"RegenerateBindings",
"ShipApi",
"SignPackages"
"SignPackages",
"Website"
]
},
"Verbosity": {
Expand Down Expand Up @@ -181,6 +182,10 @@
"type": "string"
}
},
"SkipContributorsScrape": {
"type": "boolean",
"description": "If enabled, skips scraping the contributors for the authors.yml file of the blog"
},
"Solution": {
"type": "string",
"description": "Path to a solution file that is automatically loaded"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: "Overview"
---

import DocCardList from '@theme/DocCardList';
import { useCurrentSidebarCategory } from '@docusaurus/theme-common';

# The Silk.NET Contributors Guide

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

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


## Getting Started

### Prerequisites
Expand Down Expand Up @@ -55,3 +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 items={useCurrentSidebarCategory().items.filter((e) => e.label != "Overview")} />
13 changes: 0 additions & 13 deletions docs/for-contributors/generators/README.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/for-contributors/generators/emitter/README.md

This file was deleted.

38 changes: 0 additions & 38 deletions docs/for-contributors/generators/emitter/about formatting.md

This file was deleted.

39 changes: 0 additions & 39 deletions docs/for-contributors/generators/emitter/visitor.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/for-contributors/generators/scraper.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/for-contributors/generators/symbol-layer/README.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/for-contributors/generators/symbol-layer/symbol-visitor.md

This file was deleted.

55 changes: 0 additions & 55 deletions docs/for-contributors/generators/symbol-layer/symbols/README.md

This file was deleted.

This file was deleted.

15 changes: 0 additions & 15 deletions docs/for-contributors/generators/symbol-layer/type-store.md

This file was deleted.

Loading
Loading