fix(ci): paths from pages (#1013)

Author: dhower-qc

.github/workflows/deploy.yml

@@ -40,13 +40,13 @@ jobs:
       - name: singularity setup
         uses: ./.github/actions/singularity-setup
       - name: run reuse
-        run: ./bin/reuse spdx -o reuse_bom
+        run: ./bin/reuse spdx -o reuse_bom.txt
       - name: Upload Reuse Manifest
         uses: actions/upload-artifact@v4
         if: (github.event_name == 'push') && (github.ref_name == 'main')
         with:
           name: reuse-manifest
-          path: reuse_bom
+          path: reuse_bom.txt
           retention-days: 1
   build-udb-api-doc:
     if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
@@ -460,3 +460,19 @@ jobs:
         with:
           name: mc100-32-ctp
           path: gen/proc_ctp/pdf/MC100-32-CTP.pdf
+  build-idl-doc:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone Github Repo Action
+        uses: actions/checkout@v4
+      - name: singularity setup
+        uses: ./.github/actions/singularity-setup
+      - name: Build IDL doc
+        run: ./bin/bundle exec asciidoctor -r idl_highlighter -a toc=left -a source-highlighter=rouge -o idl.html doc/idl.adoc
+      - name: Upload IDL Doc
+        uses: actions/upload-artifact@v4
+        if: (github.event_name == 'push') && (github.ref_name == 'main')
+        with:
+          name: idl-doc
+          path: idl.html

.github/workflows/pages.yml

@@ -33,7 +33,7 @@ jobs:
         uses: actions/download-artifact@v5
         with:
           name: reuse-manifest
-          path: _site/reuse_bom.txt
+          path: _site/
           github-token: ${{ secrets.GITHUB_TOKEN }}
           run-id: ${{ github.event.workflow_run.id }}
       - name: Download resolved spec
@@ -82,14 +82,14 @@ jobs:
         uses: actions/download-artifact@v5
         with:
           name: isa-html-manual
-          path: _site/manual
+          path: _site/manual/html
           github-token: ${{ secrets.GITHUB_TOKEN }}
           run-id: ${{ github.event.workflow_run.id }}
       - name: Download HTML ISA Manual
         uses: actions/download-artifact@v5
         with:
           name: cfg-html-manual
-          path: _site/example_cfg
+          path: _site/example_cfg/html
           github-token: ${{ secrets.GITHUB_TOKEN }}
           run-id: ${{ github.event.workflow_run.id }}
       - name: Download Instruction Appendix
@@ -211,6 +211,13 @@ jobs:
           path: _site/pdfs
           github-token: ${{ secrets.GITHUB_TOKEN }}
           run-id: ${{ github.event.workflow_run.id }}
+      - name: Download IDL Doc
+        uses: actions/download-artifact@v5
+        with:
+          name: idl-doc
+          path: idl.html
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          run-id: ${{ github.event.workflow_run.id }}
       - name: Create index
         env:
           PAGES_URL: https://riscv-software-src.github.io/riscv-unified-db

tools/ruby-gems/udb/README.adoc

@@ -12,7 +12,7 @@ under the `cfgs` directory.
 
 == Library interface
 
-The main entry point to the udb database is through the `ConfiguredArchitecture` object.
+The main entry point to the udb database is through the {Udb::ConfiguredArchitecture} object.
 You can construct one with:
 
 [source,ruby]
@@ -52,7 +52,7 @@ Examples:
 [source,bash]
 --
 udb list extensions                             # list all extensions in RISC-V
-udb list extensions --config qc_iu              # list all extensions in the $UDB_ROOT/qc_iu.yaml config
+udb list extensions --config qc_iu              # list all extensions in the $UDB_ROOT/cfgs/qc_iu.yaml config
 udb list extensions --config /path/to/cfg.yaml  # list all extensions from config /path/to/cfg.yaml
 UDB_ROOT=/path/to/root udb list extensions      # list all extensions in RISC-V, using UDB repo at /path/to/root
 

tools/ruby-gems/udb/Rakefile

@@ -1,8 +1,8 @@
 # Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
 # SPDX-License-Identifier: BSD-3-Clause-Clear
 
-# frozen_string_literal: true
 # typed: true
+# frozen_string_literal: true
 
 RUBY_UDB_ROOT = Kernel.__dir__
 
@@ -48,7 +48,7 @@ namespace :gen do
     task :api_doc do
       Dir.chdir(RUBY_UDB_ROOT) do
         FileUtils.rm_rf $root / "gen" / "udb_api_doc"
-        sh "bundle exec yard --plugin sorbet lib/**/*.rb --no-save --embed-mixins --hide-void-return -o #{$root}/gen/udb_api_doc"
+        sh "bundle exec yard --plugin sorbet lib --no-save --embed-mixins --hide-void-return -o #{$root}/gen/udb_api_doc"
       end
     end
   end

tools/scripts/pages.html.erb

@@ -11,14 +11,18 @@
     <p>Created on <%= Date.today %></p>
 
     <br/>
-    <h3>Resolved architecture</h3>
+    <h3>Resolved standard specification</h3>
+    <p>
+      The <em>resolved specification</em> is the database after applying the <code>$inherits</code> operator on data.
+      The resolved specification is what should be used by downstream tools.
+    </p>
     <ul>
       <li>
         <a href="<%= ENV["PAGES_URL"] %>/resolved_spec/index.yaml">index.yaml</a>
         Database index, as array of relative paths from <%= ENV["PAGES_URL"] %>/resolved_spec
         <ul>
           <li>
-            For example, you can find <a href="<%= ENV["PAGES_URL"] %>/resolved_spec/ext/Sm.yaml">Sm.yaml</a> at <%= ENV["PAGES_URL"] %>/resolved_spec/ext/Sm.yaml
+            For example, you can find Sm.yaml at <a href="<%= ENV["PAGES_URL"] %>/resolved_spec/ext/Sm.yaml"><%= ENV["PAGES_URL"] %>/resolved_spec/ext/Sm.yaml</a>
           </li>
         </ul>
       </li>
@@ -98,7 +102,7 @@
     <br/>
     <h3>IDL Documentation</h3>
     <ul>
-      <li><a href="<%= ENV["PAGES_URL"] %>/ruby/idl/index.html">IDL language documentation</a></li>
+      <li><a href="<%= ENV["PAGES_URL"] %>/idl.html">IDL language documentation</a></li>
     </ul>
 
     <br/>