Skip to content

Commit 17c79e6

Browse files
andrei-marinicaandrei-marinica
committed
Merge branch 'development' into sc-arch
2 parents 2161b24 + 8266a1e commit 17c79e6

File tree

305 files changed

+38782
-15114
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

305 files changed

+38782
-15114
lines changed

‎.github/workflows/deploy-production.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@ jobs:
1414
- uses: actions/checkout@v2
1515
with:
1616
ref: main
17+
fetch-depth: 0
1718
- name: Use Node.js
1819
uses: actions/setup-node@v1
1920
with:
20-
node-version: "16.x"
21+
node-version: "18.x"
2122
- name: Install packages
2223
run: npm install
2324
- name: Build website

‎.github/workflows/deploy-staging.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@ jobs:
1414
- uses: actions/checkout@v2
1515
with:
1616
ref: development
17+
fetch-depth: 0
1718
- name: Use Node.js
1819
uses: actions/setup-node@v1
1920
with:
20-
node-version: "16.x"
21+
node-version: "18.x"
2122
- name: Install packages
2223
run: npm install
2324
- name: Build website

‎.github/workflows/test-build.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: test-build
2+
3+
on:
4+
pull_request:
5+
branches: [main, development]
6+
workflow_dispatch:
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
- name: Use Node.js
14+
uses: actions/setup-node@v1
15+
with:
16+
node-version: "18.x"
17+
- name: Install packages
18+
run: npm install
19+
- name: Build website
20+
run: npm run build

‎.markdownlint.jsonc

Lines changed: 276 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,276 @@
1+
// Example markdownlint configuration with all properties set to their default value
2+
{
3+
// Default state for all rules
4+
"default": true,
5+
6+
// Path to configuration file to extend
7+
"extends": null,
8+
9+
// MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md001.md
10+
"MD001": true,
11+
12+
// MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md003.md
13+
"MD003": {
14+
// Heading style
15+
"style": "consistent"
16+
},
17+
18+
// MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md004.md
19+
"MD004": {
20+
// List style
21+
"style": "consistent"
22+
},
23+
24+
// MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md005.md
25+
"MD005": true,
26+
27+
// MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md007.md
28+
"MD007": {
29+
// Spaces for indent
30+
"indent": 2,
31+
// Whether to indent the first level of the list
32+
"start_indented": false,
33+
// Spaces for first level indent (when start_indented is set)
34+
"start_indent": 2
35+
},
36+
37+
// MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md009.md
38+
"MD009": {
39+
// Spaces for line break
40+
"br_spaces": 2,
41+
// Allow spaces for empty lines in list items
42+
"list_item_empty_lines": false,
43+
// Include unnecessary breaks
44+
"strict": false
45+
},
46+
47+
// MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md010.md
48+
"MD010": {
49+
// Include code blocks
50+
"code_blocks": true,
51+
// Fenced code languages to ignore
52+
"ignore_code_languages": [],
53+
// Number of spaces for each hard tab
54+
"spaces_per_tab": 1
55+
},
56+
57+
// MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md011.md
58+
"MD011": true,
59+
60+
// MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md012.md
61+
"MD012": {
62+
// Consecutive blank lines
63+
"maximum": 1
64+
},
65+
66+
// MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
67+
"MD013": false,
68+
69+
// MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md014.md
70+
"MD014": true,
71+
72+
// MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md018.md
73+
"MD018": true,
74+
75+
// MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md019.md
76+
"MD019": true,
77+
78+
// MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md020.md
79+
"MD020": true,
80+
81+
// MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md021.md
82+
"MD021": true,
83+
84+
// MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md022.md
85+
"MD022": {
86+
// Blank lines above heading
87+
"lines_above": 1,
88+
// Blank lines below heading
89+
"lines_below": 1
90+
},
91+
92+
// MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md023.md
93+
"MD023": true,
94+
95+
// MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md024.md
96+
"MD024": {
97+
// Only check sibling headings
98+
"siblings_only": false
99+
},
100+
101+
// MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md025.md
102+
"MD025": {
103+
// Heading level
104+
"level": 1,
105+
// RegExp for matching title in front matter
106+
"front_matter_title": "^\\s*title\\s*[:=]"
107+
},
108+
109+
// MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md026.md
110+
"MD026": {
111+
// Punctuation characters
112+
"punctuation": ".,;:!。，；：！"
113+
},
114+
115+
// MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md027.md
116+
"MD027": true,
117+
118+
// MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md028.md
119+
"MD028": true,
120+
121+
// MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md029.md
122+
"MD029": {
123+
// List style
124+
"style": "one_or_ordered"
125+
},
126+
127+
// MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md030.md
128+
"MD030": {
129+
// Spaces for single-line unordered list items
130+
"ul_single": 1,
131+
// Spaces for single-line ordered list items
132+
"ol_single": 1,
133+
// Spaces for multi-line unordered list items
134+
"ul_multi": 1,
135+
// Spaces for multi-line ordered list items
136+
"ol_multi": 1
137+
},
138+
139+
// MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md031.md
140+
"MD031": {
141+
// Include list items
142+
"list_items": true
143+
},
144+
145+
// MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md032.md
146+
"MD032": true,
147+
148+
// MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md
149+
"MD033": {
150+
// Allowed elements
151+
"allowed_elements": []
152+
},
153+
154+
// MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md034.md
155+
"MD034": true,
156+
157+
// MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md035.md
158+
"MD035": {
159+
// Horizontal rule style
160+
"style": "consistent"
161+
},
162+
163+
// MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md036.md
164+
"MD036": {
165+
// Punctuation characters
166+
"punctuation": ".,;:!?。，；：！？"
167+
},
168+
169+
// MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md037.md
170+
"MD037": true,
171+
172+
// MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md038.md
173+
"MD038": true,
174+
175+
// MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md039.md
176+
"MD039": true,
177+
178+
// MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md040.md
179+
"MD040": {
180+
// List of languages
181+
"allowed_languages": [],
182+
// Require language only
183+
"language_only": false
184+
},
185+
186+
// MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md041.md
187+
"MD041": {
188+
// Heading level
189+
"level": 1,
190+
// RegExp for matching title in front matter
191+
"front_matter_title": "^\\s*title\\s*[:=]"
192+
},
193+
194+
// MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md042.md
195+
"MD042": true,
196+
197+
// MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md043.md
198+
"MD043": false,
199+
200+
// MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md044.md
201+
"MD044": {
202+
// List of proper names
203+
"names": [],
204+
// Include code blocks
205+
"code_blocks": true,
206+
// Include HTML elements
207+
"html_elements": true
208+
},
209+
210+
// MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md045.md
211+
"MD045": true,
212+
213+
// MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md046.md
214+
"MD046": {
215+
// Block style
216+
"style": "consistent"
217+
},
218+
219+
// MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md047.md
220+
"MD047": true,
221+
222+
// MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md048.md
223+
"MD048": {
224+
// Code fence style
225+
"style": "consistent"
226+
},
227+
228+
// MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md049.md
229+
"MD049": {
230+
// Emphasis style
231+
"style": "consistent"
232+
},
233+
234+
// MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md050.md
235+
"MD050": {
236+
// Strong style
237+
"style": "consistent"
238+
},
239+
240+
// MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md051.md
241+
"MD051": true,
242+
243+
// MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md052.md
244+
"MD052": {
245+
// Include shortcut syntax
246+
"shortcut_syntax": false
247+
},
248+
249+
// MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md053.md
250+
"MD053": false,
251+
252+
// MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md054.md
253+
"MD054": {
254+
// Allow autolinks
255+
"autolink": true,
256+
// Allow inline links and images
257+
"inline": true,
258+
// Allow full reference links and images
259+
"full": true,
260+
// Allow collapsed reference links and images
261+
"collapsed": true,
262+
// Allow shortcut reference links and images
263+
"shortcut": true,
264+
// Allow URLs as inline links
265+
"url_inline": true
266+
},
267+
268+
// MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md055.md
269+
"MD055": {
270+
// Table pipe style
271+
"style": "consistent"
272+
},
273+
274+
// MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md056.md
275+
"MD056": true
276+
}

‎README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
# MultiversX docs
1+
# MultiversX Docs
22

33
The repository contains the [documentation](https://docs.multiversx.com) for the MultiversX Network protocol.
44

5+
![docs.multiversx.com](https://github.com/multiversx/mx-docs/blob/main/static/img/social.jpg)
6+
57
## About
68

79
The documentation is built over a custom [docusaurus](https://docusaurus.io/) solution and relies on Markdown files.
@@ -11,13 +13,13 @@ This repository also has GitHub actions that will trigger the real-time updating
1113

1214
In order to ensure that the newly added content is correctly aligned and every Markdown feature is working as intended, one can run the project on a local machine.
1315

14-
### Requirements:
16+
### Requirements
1517

1618
- a `git` client installed
17-
- `nodejs` (v16.14.2) and `npm` installed
19+
- `nodejs` (v18.19.0 LTS) and `npm` installed
1820
- optional, but useful: an IDE (Visual Code for example)
1921

20-
### Steps:
22+
### Steps
2123

2224
- clone the repository
2325
- run `npm install` (only for the first usage)
@@ -44,7 +46,7 @@ Anyone can contribute to the docs. Any help is appreciated. Here are some ways i
4446

4547
### Guidelines
4648

47-
Each documentation page should include a `Edit this page` link that will redirect the user to the corresponding GitHub edit page.
49+
Each documentation page should include a `Edit this page` link that will redirect the user to the corresponding GitHub edit page.
4850

4951
Alternatively, contributions can be made manually by following the steps below:
5052

‎docs/bridge/whitelist-requirements.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ title: Whitelist requirements
55

66
[comment]: # (mx-abstract)
77

8-
Before enabling a token to be sent via the Ad-Astra bridge, the token must be whitelisted.
8+
Before enabling a token to be sent via the Ad-Astra bridge, the token must be whitelisted.
99
The whitelisting process is performed with the help of the MultiversX team.
1010

1111
[comment]: # (mx-context-auto)
1212

1313
## Whitelist requirements
1414

1515
1. The MultiversX team must whitelist the token on both the Safe(1) and Safe(3) contracts. Only whitelisted tokens can be bridged.
16-
2. The token issuer must issue the token on the MultiversX network and submit a branding request manually or using https://assets.multiversx.com/.
17-
3. The token issuer must assign the MINT&BURN role to the BridgedTokensWrapper (6) contract as per the instructions provided at https://docs.multiversx.com/tokens/esdt-tokens/#setting-and-unsetting-special-roles
16+
2. The token issuer must issue the token on the MultiversX network and submit a branding request manually or using [https://assets.multiversx.com](https://assets.multiversx.com).
17+
3. The token issuer must assign the MINT&BURN role to the BridgedTokensWrapper (6) contract as per the instructions provided at [https://docs.multiversx.com/tokens/fungible-tokens/#setting-and-unsetting-special-roles](/tokens/fungible-tokens/#setting-and-unsetting-special-roles)
1818

1919
**Note**: As an alternative approach, MultiversX team can issue an ESDT token on the MultiversX chain with the same properties as on Ethereum, and give the needed roles to the Smart Contracts, as indicated above. The MultiversX team can then give the token issuer the ownership of token management for that specific ESDT token.

0 commit comments

Comments
 (0)