fix: fix doc generation (#77)

Signed-off-by: Shiwei Zhang <[email protected]>
oras-project · Dec 27, 2023 · d071b06 · d071b06
1 parent 6debbd6
commit d071b06
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 12 deletions.
diff --git 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 → docs/.gitignore b/documentation/.gitignore → docs/.gitignore
diff --git a/documentation/api/index.md → docs/api/index.md b/documentation/api/index.md → 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 → docs/docfx.json b/documentation/docfx.json → docs/docfx.json
@@ -6,7 +6,7 @@
           "files": [
             "**.csproj"
           ],
-          "src": "../Oras"
+          "src": "../src/OrasProject.Oras"
         }
       ],
       "dest": "api",

diff --git a/documentation/index.md → docs/index.md b/documentation/index.md → docs/index.md
diff --git a/documentation/toc.yml → docs/toc.yml b/documentation/toc.yml → docs/toc.yml
@@ -3,6 +3,3 @@
 - name: Documentation
   href: /oras-dotnet/api
   homepage: api/index.html
-
-
-