From d071b06b2465bd964cafea1a3acfab7aaf003fbc Mon Sep 17 00:00:00 2001 From: Shiwei Zhang Date: Wed, 27 Dec 2023 10:58:34 +0800 Subject: [PATCH] fix: fix doc generation (#77) Signed-off-by: Shiwei Zhang --- .github/workflows/deploy-to-github-pages.yml | 14 +++++++------- {documentation => docs}/.gitignore | 0 {documentation => docs}/api/index.md | 2 +- {documentation => docs}/docfx.json | 2 +- {documentation => docs}/index.md | 0 {documentation => docs}/toc.yml | 3 --- 6 files changed, 9 insertions(+), 12 deletions(-) rename {documentation => docs}/.gitignore (100%) rename {documentation => docs}/api/index.md (90%) rename {documentation => docs}/docfx.json (96%) rename {documentation => docs}/index.md (100%) rename {documentation => docs}/toc.yml (97%) diff --git a/.github/workflows/deploy-to-github-pages.yml b/.github/workflows/deploy-to-github-pages.yml index 71a6867..6873a0b 100644 --- a/.github/workflows/deploy-to-github-pages.yml +++ b/.github/workflows/deploy-to-github-pages.yml @@ -7,11 +7,11 @@ jobs: build-and-deploy: runs-on: ubuntu-latest environment: - name: github-pages - url: ${{steps.deployment.outputs.page_url}} + name: github-pages + url: ${{steps.deployment.outputs.page_url}} permissions: - id-token: write - pages: write + id-token: write + pages: write steps: - name: Checkout Repository uses: actions/checkout@v4 @@ -27,17 +27,17 @@ jobs: - name: Build Documentation run: | - cd documentation + cd docs docfx metadata docfx.json docfx build - name: Setup Pages uses: actions/configure-pages@v3 - + - name: Upload Artifact uses: actions/upload-pages-artifact@v2 with: - path: ./documentation/_site + path: ./docs/_site name: mydocs - name: Deploy to GitHub Pages diff --git a/documentation/.gitignore b/docs/.gitignore similarity index 100% rename from documentation/.gitignore rename to docs/.gitignore diff --git a/documentation/api/index.md b/docs/api/index.md similarity index 90% rename from documentation/api/index.md rename to docs/api/index.md index 0365c63..63ff752 100644 --- a/documentation/api/index.md +++ b/docs/api/index.md @@ -1,3 +1,3 @@ -Oras-Dotnet API Documentation +# ORAS .NET API Documentation Welcome to the oras-dotnet API documentation page. Here, you will find a comprehensive listing of APIs that oras-dotnet provides for interacting with OCI Artifacts in your .NET applications. This page is your reference for the methods, classes, and functionalities available in oras-dotnet. diff --git a/documentation/docfx.json b/docs/docfx.json similarity index 96% rename from documentation/docfx.json rename to docs/docfx.json index 8b484ab..1f11485 100644 --- a/documentation/docfx.json +++ b/docs/docfx.json @@ -6,7 +6,7 @@ "files": [ "**.csproj" ], - "src": "../Oras" + "src": "../src/OrasProject.Oras" } ], "dest": "api", diff --git a/documentation/index.md b/docs/index.md similarity index 100% rename from documentation/index.md rename to docs/index.md diff --git a/documentation/toc.yml b/docs/toc.yml similarity index 97% rename from documentation/toc.yml rename to docs/toc.yml index a5ae596..60ae719 100644 --- a/documentation/toc.yml +++ b/docs/toc.yml @@ -3,6 +3,3 @@ - name: Documentation href: /oras-dotnet/api homepage: api/index.html - - -