doc: - converted the architecture diagram into an actual image

- mentioned CONTRIBUTING doc in the introduction
gked · Nov 16, 2024 · 6800223 · 6800223
1 parent 53851d6
commit 6800223
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/docs/dev/assets/images/bastyon-architecture-overview.png b/docs/dev/assets/images/bastyon-architecture-overview.png
diff --git a/docs/dev/introduction.md b/docs/dev/introduction.md
@@ -17,6 +17,10 @@ Bastyon utilizes its native cryptocurrency, [PKOIN](https://www.coingecko.com/en
 
 The application flow architecture largerly depends on the content, users are interacting with. From a high-level, the architecture of Bastyon looks like the following:
 
+![bastyon-architecture-overview](/dev/assets/images/bastyon-architecture-overview.png)
+
+<!-- bastyon-architecture-overview diagram mermaid code 
+
 ```mermaid
 %%{init: { 'theme': 'default', 'fontSize': 10, 'flowchart': { 'nodeSpacing': 30, 'rankSpacing': 50, 'padding': 5 } }}%%
 flowchart TB
@@ -57,7 +61,7 @@ flowchart TB
     BA --- PT1
     BA --- M
 ```
-
+-->
 <!-- Add more architectural detail as needed -->
 
 <!-- todo

diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
@@ -57,8 +57,8 @@ Instructions for launching and maintaining a blockchain node:
 ### Contribution
 
 This project exists, thanks to the dedication of people who are passionate about liberating communications across the globe. Whether you are an engineer, an author, a community advocate, or just a believer, we would love your help with this project! Here are a few resources to help you with any questions you may have.
-Here are a few resorces.
 
+- Checkout out [CONTRIBUTING](/dev/CONTRIBUTING.md) doc.
 - You can reach out to us on [GitHub](https://github.com/pocketnetteam)
 - We are also just one [an email](mailto:[email protected])