Skip to content
This repository was archived by the owner on Aug 13, 2024. It is now read-only.

update Changing_Tutorial_Text with all changes from main #51

Open
wants to merge 22 commits into
base: Changing_Tutorial_Text
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
e5f9274
Merge pull request #44 from MXCzkEVM/Changing_Tutorial_Text
sheenhx Jun 14, 2024
a03e7d9
Merge pull request #45 from MXCzkEVM/Changing_Tutorial_Text
MajorDomDePIN Jun 14, 2024
3c2fe1f
Update indexer.mdx
MajorDomDePIN Jun 14, 2024
1561904
Update Presentations.md
sheenhx Jun 17, 2024
f3a664a
Merge pull request #46 from MXCzkEVM/hk
sheenhx Jun 17, 2024
e6340c2
Update intro.md
MoonchainMaxi Jun 17, 2024
4e40b00
Update Presentations.md
sheenhx Jun 18, 2024
ac18559
Update Contracts.md
sheenhx Jun 18, 2024
6108e82
Merge pull request #47 from MXCzkEVM/brand
sheenhx Jun 18, 2024
46310b9
Update Job.md
sheenhx Jun 18, 2024
c8e6ee3
Merge pull request #48 from MXCzkEVM/job
sheenhx Jun 18, 2024
9fee412
Update Address.md
MajorDomDePIN Jun 24, 2024
c8bf3aa
Merge pull request #49 from MXCzkEVM/Changing_Tutorial_Text
SanghamitraBhowmick1993 Jun 24, 2024
68cd312
Update build-a-dapp.md
MajorDomDePIN Jun 25, 2024
373c92e
Merge pull request #52 from FTI1DS/patch-1
SanghamitraBhowmick1993 Jun 27, 2024
3b0c8e6
Movded items from offline repository source folder to destination folder
OohSorryy Jun 28, 2024
f8c2d0a
"Moved all items from offline source folder"
OohSorryy Jun 28, 2024
1d308b0
Added more documentation & made updates
MoonchainMaxi Aug 12, 2024
670e87d
Added more documentation & made updates
MoonchainMaxi Aug 12, 2024
dc8e4e4
Merge branch 'Moonchain-Documentation-V2' of https://github.com/MXCzk…
MoonchainMaxi Aug 12, 2024
918004c
Merge branch 'Moonchain-Documentation-V2'
MoonchainMaxi Aug 12, 2024
1f09e59
Merge pull request #59 from MXCzkEVM/Moonchain-Documentation-V2
MoonchainMaxi Aug 12, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/FUNDING.yml

This file was deleted.

55 changes: 0 additions & 55 deletions .github/workflows/main.yml

This file was deleted.

24 changes: 0 additions & 24 deletions .github/workflows/test-action.yml

This file was deleted.

4 changes: 0 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
.cache-loader

# Misc
.idea
.DS_Store
.env.local
.env.development.local
Expand All @@ -19,6 +18,3 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Editor
.idea
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

127 changes: 25 additions & 102 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,118 +1,41 @@
# Deploy Docusaurus website to GitHub Pages using GitHub Actions
# Website

This repository is an example of deploying a Docusaurus website to GitHub Pages using GitHub Actions.
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

## Configuring the GitHub repository
### Installation

It uses the _new_ GitHub Pages experience with GitHub Actions to deploy the website.

Enable this experience in _GitHub.com -> Repository -> Settings -> Pages -> Build and deployment -> Source_ by selecting _GitHub Actions_ instead of the legacy _Deploy from a branch_ option.

In _GitHub.com -> Repository -> Settings -> Environments_ you should see a GitHub Environment named `github-pages`.

## Configuring Docusaurus
```
$ yarn
```

Generate a Docusuarus website using the following command:
### Local Development

```shell
yarn create docusaurus <folder-name> classic --typescript
```
$ yarn start
```

Make the following changes to the `docusaurus.config.js` configuration file:
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

1. Create the constants `organizationName` and `projectName`
```javascript
const organizationName = "<github-organization-name>";
const projectName = "<repository-name>";
```
1. Set the URL
```javascript
const config = {
// (...)
url: `https://${organizationName}.github.io`,
};
const baseUrl = /${projectName}/`;
```
1. Configure the base URL
```javascript
const config = {
// (...)
baseUrl: `/${projectName}/`,
};
```
1. Set the `organizationName` and `projectName` options
### Build

```javascript
const organizationName = "<github-organization-name>";
const projectName = "<repository-name>";
```
$ yarn build
```

const config = {
// (...)
organizationName,
projectName,
};
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.

1. Configure the blog and docs edit URLs
```javascript
const config = {
// (...)
presets: [
[
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
// (...)
docs: {
// (...)
editUrl: `https://github.com/${organizationName}/${projectName}/tree/main/`,
},
blog: {
// (...)
editUrl: `https://github.com/${organizationName}/${projectName}/tree/main/`,
},
}),
],
],
};
```
### Deployment

## Adding a GitHub Actions deployment workflow
Using SSH:

Use a GitHub Actions workflow template for GitHub Pages from the [`actions/starter-workflows`](https://github.com/actions/starter-workflows) repository. Place it in `.github/workflows/<workflow-name>.yml`.
```
$ USE_SSH=true yarn deploy
```

Add steps for building the website before the GitHub Pages actions are executed and specify the `path` to the `actions/upload-pages-artifact`:
Not using SSH:

```yaml
# (...)
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
# 👇 Build steps
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 16.x
cache: yarn
- name: Install dependencies
run: yarn install --frozen-lockfile --non-interactive
- name: Build
run: yarn build
# 👆 Build steps
- name: Setup Pages
uses: actions/configure-pages@v1
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# 👇 Specify build output path
path: build
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
16 changes: 16 additions & 0 deletions blog/tags.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
facebook:
label: Facebook
permalink: /facebook
description: Facebook tag description
hello:
label: Hello
permalink: /hello
description: Hello tag description
docusaurus:
label: Docusaurus
permalink: /docusaurus
description: Docusaurus tag description
hola:
label: Hola
permalink: /hola
description: Hola tag description
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: BridgeCustomErrors
sidebar_position: 2
---

## BridgeCustomErrors
# Bridge Custom Errors

### B_CANNOT_RECEIVE

Expand Down Expand Up @@ -134,4 +134,4 @@ error B_WRONG_TO_ADDRESS()

```solidity
error B_ZERO_SIGNAL()
```
```
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
## BridgedERC20
---
sidebar_position: 4
---

# Bridged ERC20

### srcToken

Expand Down Expand Up @@ -70,4 +74,4 @@ _any address can call this_
function source() public view returns (address, uint256)
```

_returns the srcToken being bridged and the srcChainId_
_returns the srcToken being bridged and the srcChainId_
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
## BridgeErrors
---
sidebar_position: 3
---

# Bridge Errors

### B_CANNOT_RECEIVE

Expand Down Expand Up @@ -130,4 +134,4 @@ error B_WRONG_TO_ADDRESS()

```solidity
error B_ZERO_SIGNAL()
```
```
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
## Bridge
---
sidebar_position: 1
---

# Bridge

Bridge contract which is deployed on both L1 and L2. Mostly a thin wrapper
which calls the library implementations. See _IBridge_ for more details.
Expand Down Expand Up @@ -122,4 +126,4 @@ function hashMessage(struct IBridge.Message message) public pure returns (bytes3

```solidity
function getMessageStatusSlot(bytes32 msgHash) public pure returns (bytes32)
```
```
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
## EtherVault
---
sidebar_position: 5
---

# Ether Vault

EtherVault is a special vault contract that:

Expand Down Expand Up @@ -94,4 +98,4 @@ Get the authorized status of an address.

| Name | Type | Description |
| ---- | ------- | ---------------------------------------- |
| addr | address | Address to get the authorized status of. |
| addr | address | Address to get the authorized status of. |
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
## IBridge
---
sidebar_position: 6
---

# I Bridge

Bridge interface.

Expand Down Expand Up @@ -106,4 +110,4 @@ Returns the bridge state context.

```solidity
function hashMessage(struct IBridge.Message message) external pure returns (bytes32)
```
```
Loading