Improve documentation workflow and update README

Author: ayushshrivastv

.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,17 @@ 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
+          ./scripts/build-docs.sh
+      
       - name: Setup Pages
         uses: actions/configure-pages@v5
 

README.md

@@ -62,23 +62,27 @@ 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
+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 --hosting-base-path OpenAPI-Integration-with-DocC
 ```
 
 ## 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
 
@@ -87,7 +91,7 @@ You can serve the documentation locally using one of these methods:
 #### Using the helper script:
 
 ```bash
-./serve-docs.sh
+./scripts/serve-docs.sh
 ```
 
 #### Using Python 3 directly:
@@ -114,9 +118,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