Merge pull request #41 from ayushshrivastv/API-documentation-hosting

API documentation hosting issues to prevent 404 errors

Author: ayushshrivastv

.github/workflows/jekyll-gh-pages.yml

@@ -1,10 +1,11 @@
+# This workflow is currently disabled and has been renamed to jekyll-gh-pages.yml.disabled
 # Sample workflow for building and deploying a Jekyll site to GitHub Pages
 name: Deploy Jekyll with GitHub Pages dependencies preinstalled
 
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["main"]
+    branches: ["disabled-branch"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

.github/workflows/jekyll-gh-pages.yml.disabled

@@ -0,0 +1,52 @@
+# This workflow is currently disabled
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["disabled-branch"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    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

.github/workflows/pages.yml

@@ -15,7 +15,7 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  deploy:
+  build-and-deploy:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
@@ -24,6 +24,18 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Setup Swift
+        uses: swift-actions/setup-swift@v1
+        with:
+          swift-version: "5.9"
+      
+      - name: Build DocC documentation
+        run: |
+          swift build
+          chmod +x ./scripts/build-docs.sh
+          # The build script now handles path fixing automatically
+          ./scripts/build-docs.sh
+      
       - name: Setup Pages
         uses: actions/configure-pages@v5
 

README.md

@@ -13,7 +13,7 @@ OpenAPI is the industry standard for documenting HTTP services, but Swift develo
 The project is organized into several modules:
 
 - `Sources/Core` - Core functionality and data models
-- `Sources/CLI` - Command-line interface 
+- `Sources/CLI` - Command-line interface
 - `Sources/OpenAPItoSymbolGraph` - Main implementation with submodules:
   - `Mapping` - Mappers between OpenAPI and SymbolGraph
   - `Utils/DocC` - DocC integration utilities
@@ -62,32 +62,44 @@ The tool has also been tested with the standard Swagger Pet Store OpenAPI defini
 swift run openapi-to-symbolgraph Examples/petstore.yaml --output-path petstore.symbolgraph.json
 ```
 
-2. Create a DocC documentation catalog (see `API.docc` as an example)
+2. Generate the documentation using our helper script:
 
-3. Generate the documentation:
+```bash
+./scripts/build-docs.sh
+```
+
+Or manually with DocC:
 
 ```bash
 xcrun docc convert YourAPI.docc --fallback-display-name YourAPI --fallback-bundle-identifier com.example.YourAPI --fallback-bundle-version 1.0.0 --additional-symbol-graph-dir ./ --output-path ./docs
 ```
 
 ## Viewing the Documentation
 
-The `docs/` directory in this repository contains the pre-generated DocC documentation website output for the **Swagger Pet Store API**, which was built using the `petstore.symbolgraph.json` generated by this tool and the `API.docc` catalog.
+The `docs/` directory in this repository contains the pre-generated DocC documentation website output for the **Swift Package Registry API**, which was built using the `registry.symbolgraph.json` generated by this tool and the `RegistryAPI.docc` catalog.
 
 ### Documentation
 
 The latest documentation is automatically deployed to GitHub Pages and can be viewed at:
 
-[https://ayushshrivastv.github.io/OpenAPI-integration-with-DocC/](https://ayushshrivastv.github.io/OpenAPI-integration-with-DocC/)
+[https://ayushshrivastv.github.io/OpenAPI-Integration-with-DocC/](https://ayushshrivastv.github.io/OpenAPI-Integration-with-DocC/)
 
 ### Local Documentation Server
 
 You can serve the documentation locally using one of these methods:
 
-#### Using the helper script:
+#### Using the local preview script (recommended):
+
+```bash
+./scripts/local-preview.sh
+```
+
+This script serves the documentation directory and opens it in your browser. You will be automatically redirected to the API documentation.
+
+#### Using the server script:
 
 ```bash
-./serve-docs.sh
+./scripts/serve-docs.sh
 ```
 
 #### Using Python 3 directly:
@@ -114,9 +126,10 @@ Check out the `DocsExample` directory for a working example of a REST API docume
 This repository is configured to automatically deploy documentation to GitHub Pages whenever changes are pushed to the main branch. The deployment process:
 
 1. Uses the GitHub Actions workflow defined in `.github/workflows/pages.yml`
-2. Takes the contents of the `docs` directory
-3. Deploys them to GitHub Pages
-4. Makes the documentation available at the URL: [https://ayushshrivastv.github.io/OpenAPI-integration-with-DocC/](https://ayushshrivastv.github.io/OpenAPI-integration-with-DocC/)
+2. Builds the documentation from the OpenAPI specification
+3. Takes the contents of the `docs` directory
+4. Deploys them to GitHub Pages
+5. Makes the documentation available at the URL: [https://ayushshrivastv.github.io/OpenAPI-Integration-with-DocC/](https://ayushshrivastv.github.io/OpenAPI-Integration-with-DocC/)
 
 ## Contributing