Skip to content

Commit

Permalink
chore: update images (#47)
Browse files Browse the repository at this point in the history
  • Loading branch information
b00f authored Jul 31, 2024
1 parent 84e6a0f commit 7d6f142
Show file tree
Hide file tree
Showing 57 changed files with 34 additions and 14 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,6 @@ jobs:
## By swap-urls, we don't get error if we rename or move a document.
- name: Check for broken links
run: htmlproofer --swap-urls 'https\://docs.pactus.org:' --ignore-status-codes "999,429,403,0" --ignore-urls=/github.com/,/cdn./,/discord.gg/,/t.me/,/tools.ietf.org/,/www.googletagmanager.com/,/googletagmanager.com/ ./public

- name: Check images
run: python .github/workflows/check_images.py ./static/images
17 changes: 17 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
build:
hugo

serve:
hugo serve

check: build
mdl --style=.mdlrc.rb ./content
htmlproofer --enforce-https=false --ignore-missing-alt=true --ignore-status-codes "999,429,403,0" --ignore-urls=/github.com/,/cdn./,/discord.gg/,/t.me/,/tools.ietf.org/,/www.googletagmanager.com/,/googletagmanager.com/ ./public
python3 .github/workflows/check_images.py ./static/images

exif:
for i in $(shell find ./static/images -name "*.png" -o -name "*.gif" -o -name "*.jpg" -o -name "*.jpeg"); do \
echo "Processing $$i"; \
exiftool -all= "$$i"; \
done

22 changes: 11 additions & 11 deletions content/get-started/pactus-gui.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Windows and macOS users may encounter a warning message stating that Pactus is a
This is because Pactus does not have a
[code signing certificate](https://en.wikipedia.org/wiki/Code_signing).

![Code certificate issue](/images/topic/pactus-gui/code-certificate-warning.png)
![Code certificate issue](/images/pactus-gui/code-certificate-warning.png)

A code certificate is a digital signature that verifies the identity and authenticity of the software publisher.
However, obtaining a code certificate is complex and expensive process, and requires registering a company and
Expand All @@ -40,27 +40,27 @@ Therefore, you can safely ignore the warning message and proceed with installing
To install Pactus GUI, simply follow the on-screen instructions provided by the installer.
The process is straightforward and similar to installing any other application on your computer.

![Installing Pactus](/images/topic/pactus-gui/installing.png)
![Installing Pactus](/images/pactus-gui/installing.png)

## Initializing

When you run Pactus for the first time, a wizard dialog will appear to guide you through the wallet creation and
initialization process. This process consists of several steps:

### Initialize Mode
### Wallet Mode

On the first page, you will ask you how you want to create your wallet.
Select the option to "Create a new wallet from scratch" and proceed to the next page.

![Initialize mode](/images/topic/pactus-gui/initialize-mode.png)
![Initialize mode](/images/pactus-gui/wallet-mode.png)

### Wallet Seed

The next page will display your wallet seed phrase, which consists of 12 words.
It is essential to securely back up this seed phrase, as it is required for wallet recovery
in case your computer is lost, damaged, or stolen.

![Wallet seed](/images/topic/pactus-gui/wallet-seed.png)
![Wallet seed](/images/pactus-gui/wallet-seed.png)

{{< callout type="warning" >}}
<b>Wallet seed is important</b>
Expand All @@ -75,15 +75,15 @@ In this step, you will be asked to confirm your seed phrase.
Input the 12 words you received in the previous step into the dialog.
If the seed phrase is entered correctly, you will be able to proceed to the next page.

![Seed confirmation](/images/topic/pactus-gui/seed-confirmation.png)
![Seed confirmation](/images/pactus-gui/seed-confirmation.png)

### Wallet Password

On this page, you will be asked to set a password for your wallet.
Enter a strong password in the first dialog box and confirm it in the second one.
This password will be used to encrypt your wallet and protect it from unauthorized access.

![Set wallet password](/images/topic/pactus-gui/wallet-password.png)
![Set wallet password](/images/pactus-gui/wallet-password.png)

Note: Choose a strong password and keep it safe.
If you forget or lose your password, you will need your seed phrase to regain access to your wallet.
Expand All @@ -94,7 +94,7 @@ Each node in the Pactus blockchain can run up to 32 validators, and each validat
1000 coins. Here, you can define how many validators you want to create for your node.
Select the number of validators based on the amount of coins you want to stake.

![Number of validators](/images/topic/pactus-gui/number-of-validators.png)
![Number of validators](/images/pactus-gui/number-of-validators.png)

If you want to stake more than 32,000 coins, you need to set up a new node.

Expand All @@ -103,7 +103,7 @@ If you want to stake more than 32,000 coins, you need to set up a new node.
The last page of the initialization process shows the node information, such as the working directory, validator address,
and reward address. Review this information and click "Close" to complete the initialization process.

![Node information](/images/topic/pactus-gui/node-information.png)
![Node information](/images/pactus-gui/node-information.png)

Upon closing the wizard dialog, your Pactus node will start running. You are now ready to use Pactus in GUI mode.

Expand All @@ -119,14 +119,14 @@ When the Pactus node starts running, it begins syncing with the network. This pr
as your node needs to download and verify the entire blockchain history.
Please be patient while your node syncs.

![Syncing progress](/images/topic/pactus-gui/syncing-progress.png)
![Syncing progress](/images/pactus-gui/syncing-progress.png)

### Default Wallet

You can check the "Default Wallet" tab to access your wallet information. Please note that the displayed
information may not be accurate until the syncing process is complete.

![Default Wallet tab](/images/topic/pactus-gui/default-wallet.png)
![Default Wallet tab](/images/pactus-gui/default-wallet.png)

In the "Default Wallet" tab, you can view your account details, including your balance and
address information such as the **validator and reward addresses**.
Expand Down
2 changes: 1 addition & 1 deletion content/get-started/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ If you have a firewall, you should check this.
You can check by <a href="https://portchecker.co/" rel="nofollow noindex noreferrer" target="_blank">online service</a>
for this port is open or close.

![Open port in firewall](/images/open-port.jpg)
![Open port in firewall](/images/open-port.png)

## Avoid running node with the same validators on different machines

Expand Down
4 changes: 2 additions & 2 deletions content/protocol/consensus/protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ the block is committed, and the next proposer is ready to propose a new block. T
If a proposer fails to propose in any round, other validators start the "change proposer" phase to
decide to change the proposer for this round.

![Pactus consensus states](/images/pactus-consensus-states.png)
![Pactus consensus states](/images/consensus/pactus-consensus-states.png)

## The Algorithm

Expand Down Expand Up @@ -106,7 +106,7 @@ block-announce message, even if their timer has expired.
The picture below shows the operation of the algorithm in the normal case. validator 1 is the
proposer and validator 4 is faulty.

![Normal execution](/images/pactus-consensus-normal-execution.png)
![Normal execution](/images/consensus/pactus-consensus-normal-execution.png)

### Change Proposer

Expand Down
Binary file modified static/images/android-chrome-96x96.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/images/confirm-seed.png
Binary file not shown.
File renamed without changes
Binary file removed static/images/default-wallet.png
Binary file not shown.
Binary file modified static/images/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/images/finish-wizard.png
Binary file not shown.
Binary file removed static/images/generated-seed.png
Binary file not shown.
Binary file removed static/images/initialize-mode.png
Binary file not shown.
Binary file modified static/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/mstile-150x150.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/images/node-info.png
Binary file not shown.
Binary file removed static/images/number-of-validators.png
Binary file not shown.
Binary file removed static/images/open-port.jpg
Binary file not shown.
Binary file added static/images/open-port.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added static/images/pactus-gui/default-wallet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
Binary file added static/images/pactus-gui/node-type.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/pactus-gui/seed-confirmation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/pactus-gui/summary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/pactus-gui/syncing-progress.png
Binary file added static/images/pactus-gui/wallet-mode.png
Binary file added static/images/pactus-gui/wallet-password.png
Binary file added static/images/pactus-gui/wallet-seed.png
Binary file removed static/images/syncing-progress.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed static/images/topic/become-a-validator/node-info.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed static/images/topic/become-a-validator/wallets.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed static/images/topic/pactus-gui/default-wallet.png
Diff not rendered.
Binary file removed static/images/topic/pactus-gui/initialize-mode.png
Diff not rendered.
Binary file removed static/images/topic/pactus-gui/installing.png
Diff not rendered.
Binary file removed static/images/topic/pactus-gui/node-information.png
Diff not rendered.
Diff not rendered.
Binary file removed static/images/topic/pactus-gui/seed-confirmation.png
Diff not rendered.
Binary file removed static/images/topic/pactus-gui/syncing-progress.png
Diff not rendered.
Binary file removed static/images/topic/pactus-gui/wallet-password.png
Diff not rendered.
Binary file removed static/images/topic/pactus-gui/wallet-seed.png
Diff not rendered.
Binary file removed static/images/wallet-password.png
Diff not rendered.
Binary file removed static/images/wallet-seed.png
Diff not rendered.
Binary file removed static/images/wallets.png
Diff not rendered.
Binary file removed static/images/wizard-welcome.png
Diff not rendered.

0 comments on commit 7d6f142

Please sign in to comment.