Skip to content
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
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @nexus-rpc/nexus-contributors
7 changes: 5 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
submodules: recursive

- name: Setup .NET
uses: actions/setup-dotnet@v4
Expand All @@ -32,5 +30,10 @@ jobs:
- name: Build
run: dotnet build

- name: Build docs
run: |
dotnet tool update -g docfx
docfx src/NexusRpc/docs/docfx.json --warningsAsErrors

- name: Test
run: dotnet test --logger "console;verbosity=detailed"
34 changes: 34 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Deploy Docs
on:
push:
branches:
- main

jobs:
deploy-docs:
runs-on: ubuntu-latest
needs: build-lint-test
permissions:
contents: read
pages: write
id-token: write

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup .NET
uses: actions/setup-dotnet@v4

- name: Build docs
run: |
dotnet tool update -g docfx
docfx src/NexusRpc/docs/docfx.json --warningsAsErrors

- name: Upload docs to GitHub Pages
uses: actions/upload-pages-artifact@v3
with:
path: src/NexusRpc/docs/_site

- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
**⚠️ This SDK is currently at an experimental release stage. Backwards-incompatible changes are anticipated until a
stable release is announced. ⚠️**

.NET SDK for working with [Nexus RPC](https://github.com/nexus-rpc/api).
.NET SDK for working with [Nexus RPC](https://github.com/nexus-rpc/api). See
[API documentation](https://nexus-rpc.github.io/sdk-dotnet/)

## What is Nexus?

Expand Down
3 changes: 3 additions & 0 deletions src/NexusRpc/docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/_site
/api/*.yml
/api/.manifest
9 changes: 9 additions & 0 deletions src/NexusRpc/docs/api/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0; url=NexusRpc.html">
</head>
<body>
If you are not redirected automatically, <a href="NexusRpc.html">click here</a>.
</body>
</html>
56 changes: 56 additions & 0 deletions src/NexusRpc/docs/docfx.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
{
"metadata": [
{
"src": [
{
"files": [
"*.csproj"
],
"exclude": [
"**/bin/**",
"**/obj/**"
],
"src": ".."
}
],
"dest": "api",
"includePrivateMembers": false,
"disableGitFeatures": false,
"disableDefaultFilter": false,
"noRestore": false,
"namespaceLayout": "nested",
"memberLayout": "samePage",
"allowCompilationErrors": false
}
],
"build": {
"content": [
{
"files": [
"api/**.yml"
]
}
],
"resource": [
{ "files": ["logo.svg", "index.html", "api/index.html"] }
],
"globalMetadata": {
"_appFooter": "<span></span>",
"_appName": "Nexus .NET SDK",
"_appTitle": "Nexus .NET SDK",
"_appLogoPath": "logo.svg",
"_enableSearch": false,
"_disableContribution": true
},
"output": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default",
"modern"
],
"postProcessors": [],
"keepFileLink": false,
"disableGitFeatures": false
}
}
9 changes: 9 additions & 0 deletions src/NexusRpc/docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0; url=api/NexusRpc.html">
</head>
<body>
If you are not redirected automatically, <a href="api/NexusRpc.html">click here</a>.
</body>
</html>
4 changes: 4 additions & 0 deletions src/NexusRpc/docs/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.