Merge pull request #971 from riscv/merge_asciidoc

Convert to asciidoc

.github/workflows/verify.yml

@@ -1,13 +1,38 @@
 name: Verify Build
-on: [push]
+
+on:
+  pull_request:
+  push:
+    branches:
+      - asciidoc
+
 jobs:
-    Build:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v2
-            - run: sudo apt-get update
-            - run: >
-                sudo apt-get install python3-sympy texlive-latex-base \
-                        texlive-latex-recommended texlive-latex-extra \
-                        texlive-fonts-extra texlive-science
-            - run: make draft stable release chisel
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    # Step 0: Install build requirements
+    - name: Install Build Requirements
+      run: sudo apt update && sudo apt install -y python3-sympy
+
+    # Step 1: Checkout the repository
+    - name: Checkout repository
+      uses: actions/checkout@v3
+      with:
+        submodules: 'recursive'
+
+    # Step 2: Pull the latest RISC-V Docs container image
+    - name: Pull Container
+      run: docker pull riscvintl/riscv-docs-base-container-image:latest
+
+    # Step 3: Build Files
+    - name: Build Files
+      run: cd ./build && make
+
+    # Step 4: Upload the built PDF files as a single artifact
+    - name: Upload Build Artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        name: Build Artifacts
+        path: ${{ github.workspace }}/build/*.pdf
+        retention-days: 30

.gitignore

@@ -1,27 +1,7 @@
-# LaTeX intermediate files
-*.aux
-*.idx
-*.ilg
-*.ind
-*.lof
-*.log
-*.out
-*.toc
-*.lot
-*.hst
-*.ver
-
 # Generated files
-*_registers.tex
-*_registers.tex.inc
-*_registers.h
-serial.*
-abstract_commands.*
-debug_defines.*
-
-# Changelogs
-changelog.tex
-vc.tex
+build/*.adoc
+build/images
+build/.asciidoctor
+build/*.pdf
 
-# Resulting PDFs
-riscv-debug-workgroup-notes.pdf
+.vscode

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs-resources"]
+	path = docs-resources
+	url = https://github.com/riscv/docs-resources.git

README.md

@@ -1,11 +1,10 @@
 RISC-V Debug Specification
 ==========================
 
-The current master branch is v1.0.0-frozen.
-
 You may be looking for one of the following pre-built PDFs:
-* [Latest frozen](https://github.com/riscv/riscv-debug-spec/blob/master/riscv-debug-frozen.pdf)
+* [Latest release candidate](https://github.com/riscv/riscv-debug-spec/releases)
 * [Latest release](https://github.com/riscv/riscv-debug-spec/blob/release/riscv-debug-release.pdf)
+  (This is outdated at this point, and only of historical interest.)
 
 Build Instructions
 ------------------