Merge pull request #531 from AmbireTech/contributing-and-improvements

Contributing and improvements

Author: elpiel

.github/workflows/docs.yml

@@ -20,12 +20,13 @@ jobs:
           profile: minimal
           components: rust-docs
       - name: Build docs
-        run: RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --no-deps --workspace
-      - name: Prepare /docs & index file
+        # Building locally:
+        # for `--enable-index-page` it is required to pass `-Z unstable-options` to rustdocs
+        run: RUSTDOCFLAGS="--cfg docsrs -Z unstable-options --enable-index-page" cargo +nightly doc --all-features --no-deps --workspace
+      - name: Prepare /docs
         run: |
           rm -rf ./docs
-          echo "<meta http-equiv=\"refresh\" content=\"0; url=sentry\">" > target/doc/index.html
-          cp -r target/doc ./docs
+          mv target/doc ./docs
       - name: Deploy gh-pages
         # if: github.ref == 'refs/heads/aip-61-adex-v5'
         uses: peaceiris/actions-gh-pages@v3