Merge pull request #160 from open-dollar/update-docs

Update-docs

.github/workflows/docs.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   deploy-docs:
-    if: github.repository == 'hai-on-op/hai'
+    if: github.repository == 'open-dollar/od-contracts'
     name: Deploy docs
     runs-on: ubuntu-latest
     environment:
@@ -35,7 +35,7 @@ jobs:
           version: nightly
 
       - name: Build Docs
-        run: yarn docs:build
+        run: ./build-docs.sh
 
       - name: Create book folder
         run: mdbook build docs

README.md

@@ -1,3 +1,3 @@
 # Open Dollar
 
-This repository contains the core smart contract code for HAI, a GEB fork. GEB is the abbreviation of [Gödel, Escher and Bach](https://en.wikipedia.org/wiki/G%C3%B6del,_Escher,_Bach) as well as the name of an [Egyptian god](https://en.wikipedia.org/wiki/Geb).
+This repository contains the core smart contract code for Open Dollar, a GEB fork. GEB is the abbreviation of [Gödel, Escher and Bach](https://en.wikipedia.org/wiki/G%C3%B6del,_Escher,_Bach) as well as the name of an [Egyptian god](https://en.wikipedia.org/wiki/Geb).

build-docs.sh

@@ -6,24 +6,12 @@ temp_folder="technical-docs"
 
 FOUNDRY_PROFILE=docs forge doc --out "$temp_folder"
 
-# edit generated summary not to have container pages
-# - [jobs](src/interfaces/jobs/README.md)
-# should become
-# - [jobs]()
-# TODO
-
-# edit generated summary titles to start with an uppercase letter
-# - [jobs]()
-# should become
-# - [Jobs]()
-# TODO
-
 # edit the SUMMARY after the Interfaces section
 # https://stackoverflow.com/questions/67086574/no-such-file-or-directory-when-using-sed-in-combination-with-find
 if [[ "$OSTYPE" == "darwin"* ]]; then
-  sed -i '' -e '/\Technical Documentation/q' docs/src/SUMMARY.md
+  sed -i '' -e '/\src/q' docs/src/SUMMARY.md
 else
-  sed -i -e '/\Technical Documentation/q' docs/src/SUMMARY.md
+  sed -i -e '/\src/q' docs/src/SUMMARY.md
 fi
 # copy the generated SUMMARY, from the tmp directory, without the first 5 lines
 # and paste them after the Interfaces section on the original SUMMARY
@@ -55,4 +43,4 @@ replace_text() {
 base_folder="docs/src/$root_path"
 
 # calling the function to fix the paths
-replace_text "$base_folder"
+# replace_text "$base_folder"

docs/.gitignore

@@ -0,0 +1 @@
+book/

docs/book.toml

@@ -1,18 +1,26 @@
 [book]
 src = "src"
-title = "HAI docs"
+title = "od-docs"
 description = ''
 language = 'en'
 
 [output.html]
 no-section-label = true
 theme = 'src/theme'
-additional-css = ['src/theme/css/fonts.css', 'src/theme/css/colors.css', 'src/theme/css/base.css']
-additional-js = ['src/theme/js/theme.js', 'src/theme/js/base.js', 'src/theme/js/solidity.min.js']
-git-repository-url = "https://github.com/hai-on-op/hai/"
+additional-css = [
+    'src/theme/css/fonts.css',
+    'src/theme/css/colors.css',
+    'src/theme/css/base.css',
+]
+additional-js = [
+    'src/theme/js/theme.js',
+    'src/theme/js/base.js',
+    'src/theme/js/solidity.min.js',
+]
+git-repository-url = "https://github.com/open-dollar/od-contracts/"
 git-repository-icon = 'fa-github'
 mathjax-support = true
 
 [output.html.fold]
-enable = true    # whether or not to enable section folding
-level = 1        # the depth to start folding
+enable = true # whether or not to enable section folding
+level = 1     # the depth to start folding

docs/src/README.md

@@ -1,3 +1,8 @@
-# HAI
+# Home
 
-This repository contains the core smart contract code for HAI, a GEB fork. GEB is the abbreviation of [Gödel, Escher and Bach](https://en.wikipedia.org/wiki/G%C3%B6del,_Escher,_Bach) as well as the name of an [Egyptian god](https://en.wikipedia.org/wiki/Geb).
+### @open-dollar/contracts `v1.5.4`
+
+This site was generated from our contracts using the Forge doc generator. 
+
+- Main documentation - [https://docs.opendollar.com](https://docs.opendollar.com)
+- Contracts - [https://github.com/open-dollar/od-contracts/](https://github.com/open-dollar/od-contracts/)