📝 update documentation structure

Ackee-Blockchain · May 22, 2024 · ffbf9f7 · ffbf9f7
1 parent 569c2fb
commit ffbf9f7
Show file tree

Hide file tree

Showing 18 changed files with 77 additions and 202 deletions.
diff --git a/.github/workflows/build-documentation.yaml b/.github/workflows/build-documentation.yaml
@@ -12,10 +12,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python
+        with:
+          ssh-key: ${{ secrets.DOCUMENTATION_DEPLOY_KEY }}
+      - name: Set up Python 3.10
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: "3.10"
       - uses: ./.github/actions/setup-documentation/
       - name: Fetch documentation branch
         run: git fetch origin documentation:documentation --depth=1

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 **Note**: Version 0 of Semantic Versioning is handled differently from version 1 and above. The minor version will be
 incremented upon a breaking change and the patch version will be incremented for features.
 
-## [Unreleased]
+## [dev] - Unreleased
 
 ## [0.6.0] - 2024-05-20
 ### Added

diff --git a/documentation/docs/CHANGELOG.md b/documentation/docs/CHANGELOG.md
@@ -0,0 +1 @@
+../../CHANGELOG.md
diff --git a/documentation/docs/fuzzing/fuzzing-current-limitations.md b/documentation/docs/fuzzing/fuzzing-current-limitations.md
@@ -1,3 +1,5 @@
+# Current limitations
+
 This section summarizes some known limitations in the current development stage. Further development will be focused on resolving these limitations.
 
 - Only fuzzing of one program without CPIs to other custom programs is supported.

diff --git a/documentation/docs/fuzzing/fuzzing-examples.md b/documentation/docs/fuzzing/fuzzing-examples.md
@@ -1,3 +1,5 @@
+# Fuzzing Examples
+
 ### Hello World! Example
 - [hello_world](https://github.com/Ackee-Blockchain/trident/tree/master/examples/fuzz-tests/hello_world)
 

diff --git a/documentation/docs/fuzzing/fuzzing-introduction.md b/documentation/docs/fuzzing/fuzzing-introduction.md
@@ -1,8 +1,8 @@
-# Fuzzing
+# Introduction
 
 Fuzzing is a software testing technique that involves providing invalid, unexpected, or random data as inputs to a computer program. The aim is to uncover bugs and vulnerabilities that might not be detected with conventional testing strategies.
 
-# Introduction
+# {{ config.site_name }}
 
 The `{{ config.site_name }}` testing framework equips developers with tools to efficiently develop fuzz tests for Anchor-based programs. It streamlines the fuzz testing process through automation and comprehensive support:
 

diff --git a/documentation/docs/fuzzing/fuzzing-lifecycle.md b/documentation/docs/fuzzing/fuzzing-lifecycle.md
@@ -1,3 +1,5 @@
+# Fuzz Test Lifecycle
+
 In the sequence diagram below you can see a simplified fuzz test lifecycle.
 
 Some diagram states are labeled with emojis:

diff --git a/documentation/docs/fuzzing/fuzzing-run-debug.md b/documentation/docs/fuzzing/fuzzing-run-debug.md
@@ -1,3 +1,5 @@
+# Run and Debug
+
 ## Run
 Once you have finished the implementation of the Fuzz Test, you can run the Test as follows:
 

diff --git a/documentation/docs/home/CODE_OF_CONDUCT.md b/documentation/docs/home/CODE_OF_CONDUCT.md
diff --git a/documentation/docs/home/CONTRIBUTING.md b/documentation/docs/home/CONTRIBUTING.md
diff --git a/documentation/docs/home/LICENSE.md b/documentation/docs/home/LICENSE.md
diff --git a/documentation/docs/home/home-installation.md b/documentation/docs/home/home-installation.md
@@ -1,3 +1,5 @@
+# Installation
+
 ## Dependencies
 
 Check [supported versions](#supported-versions) section for further details.

diff --git a/documentation/docs/index.md b/documentation/docs/index.md
@@ -1,5 +1,6 @@
 # {{ config.site_name }}
-Trident is a Rust-based framework to fuzz and integration test Solana programs to help you ship secure code.
+
+{{ config.site_name }} is a Rust-based framework to fuzz and integration test Solana programs to help you ship secure code.
 
 # Features
 

diff --git a/documentation/docs/integration-tests/poc-examples.md b/documentation/docs/integration-tests/poc-examples.md
@@ -1,2 +1,4 @@
+# Examples
+
 - [Escrow](https://github.com/Ackee-Blockchain/trident/tree/master/examples/integration-tests/escrow)
 - [Turnstile](https://github.com/Ackee-Blockchain/trident/tree/master/examples/integration-tests/turnstile)
diff --git a/documentation/docs/integration-tests/poc-introduction.md b/documentation/docs/integration-tests/poc-introduction.md
@@ -1,4 +1,4 @@
-# Integration Tests
+# Introduction
 {{ config.site_name }} supports writing Integration Tests in Rust.
 
 <div>

diff --git a/documentation/docs/overrides/main.html b/documentation/docs/overrides/main.html
diff --git a/documentation/docs/stylesheets/extra.css b/documentation/docs/stylesheets/extra.css
@@ -1,5 +1,14 @@
-@import url('https://fonts.googleapis.com/css2?family=Merriweather:wght@700&display=swap');
-@import url('https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600&display=swap');
+@import url('https://fonts.googleapis.com/css2?family=Inter:[email protected]&display=swap');
+
+
+.md-typeset h1,
+.md-typeset h2,
+.md-typeset h3,
+.md-typeset h4,
+.md-typeset h5,
+.md-typeset h6 {
+    font-family: 'Inter', serif;
+}
 
 /*
     update colour of comments in code block
@@ -10,22 +19,15 @@
     --md-code-hl-comment-color: #09902d;
 }
 
-/* Update font and font size of "# Title 1" */
-.md-typeset h1 {
-    font-size: 32px;
-    font-family: 'Merriweather', serif;
-    padding: 12px;
-    margin-bottom: 20px;
-}
-
 /* Update font of basic text*/
 body {
-    font-family: 'Source Sans Pro', sans-serif;
+    font-family: 'Inter', serif;
 }
 
 /*
     rotate hue so that the image will be modified based on the background
 */
-[data-md-color-scheme="default"] .excalidraw svg, [data-md-color-scheme="default"] span.excalidraw {
+[data-md-color-scheme="default"] .excalidraw svg,
+[data-md-color-scheme="default"] span.excalidraw {
     filter: invert(1) hue-rotate(90deg);
 }
diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml
@@ -8,43 +8,40 @@ site_author: Ackee Blockchain
 
 
 nav:
-  - Home:
-    - Trident: index.md
-    - Installation: home/home-installation.md
-    - Contributing: home/CONTRIBUTING.md
-    - License: home/LICENSE.md
-    - Code of conduct: home/CODE_OF_CONDUCT.md
-  - Fuzz Tests:
-    - Introduction: fuzzing/fuzzing-introduction.md
-    - Initialization:
-        - fuzzing/initialization/fuzzing-initialization-fuzz.md
-        - fuzzing/initialization/fuzzing-initialization-fuzz-add.md
-        - fuzzing/initialization/fuzzing-initialization-all.md
-    - Fuzz Test Lifecycle: fuzzing/fuzzing-lifecycle.md
-    - How-To write Fuzz Test:
-        - fuzzing/howto/fuzzing-howto-p0.md
-        - fuzzing/howto/fuzzing-howto-p1.md
-        - fuzzing/howto/fuzzing-howto-p2.md
-        - fuzzing/howto/fuzzing-howto-p3.md
-        - fuzzing/howto/fuzzing-howto-p4.md
-        - fuzzing/howto/fuzzing-howto-p5.md
-        - fuzzing/howto/fuzzing-howto-p6.md
-        - fuzzing/howto/fuzzing-howto-p7.md
-    - Run and Debug: fuzzing/fuzzing-run-debug.md
-    - Current limitations: fuzzing/fuzzing-current-limitations.md
-    - Examples: fuzzing/fuzzing-examples.md
-  - Integration Tests:
-    - Introduction: integration-tests/poc-introduction.md
-    - Initialization:
-        - integration-tests/initialization/poc-initialization-poc.md
-        - integration-tests/initialization/poc-initialization-program-client.md
-        - integration-tests/initialization/poc-initialization-all.md
-    - How-To write Integration Test:
-        - integration-tests/howto/poc-howto-p0.md
-        - integration-tests/howto/poc-howto-p1.md
-    - Run: integration-tests/poc-run.md
-    - Examples: integration-tests/poc-examples.md
-
+  - Trident:
+    - index.md
+    - home/home-installation.md
+    - Fuzz Tests:
+      - fuzzing/fuzzing-introduction.md
+      - Initialization:
+          - fuzzing/initialization/fuzzing-initialization-fuzz.md
+          - fuzzing/initialization/fuzzing-initialization-fuzz-add.md
+          - fuzzing/initialization/fuzzing-initialization-all.md
+      - fuzzing/fuzzing-lifecycle.md
+      - How-To write Fuzz Test:
+          - fuzzing/howto/fuzzing-howto-p0.md
+          - fuzzing/howto/fuzzing-howto-p1.md
+          - fuzzing/howto/fuzzing-howto-p2.md
+          - fuzzing/howto/fuzzing-howto-p3.md
+          - fuzzing/howto/fuzzing-howto-p4.md
+          - fuzzing/howto/fuzzing-howto-p5.md
+          - fuzzing/howto/fuzzing-howto-p6.md
+          - fuzzing/howto/fuzzing-howto-p7.md
+      - fuzzing/fuzzing-run-debug.md
+      - fuzzing/fuzzing-current-limitations.md
+      - fuzzing/fuzzing-examples.md
+    - Integration Tests:
+      - integration-tests/poc-introduction.md
+      - Initialization:
+          - integration-tests/initialization/poc-initialization-poc.md
+          - integration-tests/initialization/poc-initialization-program-client.md
+          - integration-tests/initialization/poc-initialization-all.md
+      - How-To write Integration Test:
+          - integration-tests/howto/poc-howto-p0.md
+          - integration-tests/howto/poc-howto-p1.md
+      - integration-tests/poc-run.md
+      - integration-tests/poc-examples.md
+  - CHANGELOG.md
 
 # Beware this is strongly dependent on names of folders , example:
 # images have to be stored within the docs/images folder
@@ -67,14 +64,14 @@ theme:
         icon: material/lightbulb-outline
         name: Switch to light mode
   features:
-  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading
-    - navigation.instant
+  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-tabs
+    - navigation.tabs
   # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-expansion
-    # - navigation.expand
+    - navigation.expand
+  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections
+    - navigation.sections
   # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button
     - navigation.top
-  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-tabs
-    - navigation.tabs
   # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
     - navigation.indexes
   # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/?h=content+copy#code-copy-button
@@ -89,6 +86,7 @@ extra:
       link: https://discord.gg/x7qXXnGCsa
     - icon: fontawesome/brands/twitter
       link: https://twitter.com/ackeeblockchain
+# https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
   version:
     provider: mike