Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
- Docusaurus version bumped to 3.5.2
- Blank pages for Landing and Blog added
- Categories added
  • Loading branch information
Karkunow committed Aug 22, 2024
1 parent ce6a235 commit 07f29c9
Show file tree
Hide file tree
Showing 12 changed files with 5,773 additions and 3,804 deletions.
6 changes: 3 additions & 3 deletions docs/dev-reference/network-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ following networks:

| Network | Engine ID | Chain ID | Endpoint URL |
|---------------------|----------------------------|-------------------------|------------------------------|
| [Mainnet](#mainnet) | [`aurora`][aurora@Mainnet] | 1313161554 (0x4e454152) | <https://mainnet.aurora.dev> |
| [Testnet](#testnet) | [`aurora`][aurora@Testnet] | 1313161555 (0x4e454153) | <https://testnet.aurora.dev> |
| Localnet | `aurora.test.near` | 1313161556 (0x4e454154) | <http://localhost:8545> |
| [Mainnet](#mainnet) | [`aurora`][aurora@Mainnet] | 1313161554 (0x4e454152) | [https://mainnet.aurora.dev](https://mainnet.aurora.dev) |
| [Testnet](#testnet) | [`aurora`][aurora@Testnet] | 1313161555 (0x4e454153) |[https://testnet.aurora.dev](https://testnet.aurora.dev) |
| Localnet | `aurora.test.near` | 1313161556 (0x4e454154) | [http://localhost:8545](http://localhost:8545) |

Find the status page and public incident log at
[api.aurora.dev](https://api.aurora.dev).
Expand Down
1 change: 0 additions & 1 deletion docs/getting-started/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
sidebar_position: 1
sidebar_label: What is Aurora?
id: overview
slug: /
---

import ThemedImage from '@theme/ThemedImage';
Expand Down
2 changes: 1 addition & 1 deletion docs/launch-chain/configuration/initialize.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can manage and track the information about the configured Aurora Chain with

![silo_config](/img/silo_config.png)

Note the `RPC URL` field above. As you can see, the RPC endpoint looks similar to [the one Aurora Mainnet is using](/getting-started/network-endpoints), and has a format like [https://your-chain.aurora.dev](https://your-chain.aurora.dev).
Note the `RPC URL` field above. As you can see, the RPC endpoint looks similar to [the one Aurora Mainnet is using](/dev-reference/network-endpoints), and has a format like [https://your-chain.aurora.dev](https://your-chain.aurora.dev).

Talking about the RPC nodes, we will provide a scalable cluster of those for you, accessible by that link. But if you want to manage RPCs by yourself, there are two options for you:

Expand Down
4 changes: 2 additions & 2 deletions docs/launch-chain/reference/whitelists-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ title: Whitelists API
| **required request headers** | Content-Type: application/json <br/>Authorization: Bearer [**ACC API Token**]|
| **required request params** | *op_type*: `add_entry` and `remove_entry` are supported <br/>*kind*: Type of whitelist. `developer` or `user` are supported. <br/> *entry*: EOA address to add or remove.|
| **response code** | On success: `200 OK`<br/>On Error:<br/> - `400 BadRequest`: if a request body is empty or could not be parsed or a number of operations is greater than RequestConfig.MaxBatchLen<br/> - `401 Unauthorized`: if authorization header does not satisfy the [conditions](401 Conditions)<br/> - `403 Forbidden`: if a caller is [not authorized](403 Conditions) to perform all updates in request array (i.e., partial updates are not allowed)<br/> - `408 RequestTimeout`: with partial response, if not all responses from storage node are received before RequestConfig.TimeoutMs or `Timeout` header in request<br/> - `500 InternalServerError`: if fails to send an update request to the storage node, or fails to parse a response from the storage node |
| **request example** | <pre lang="shell">curl --location --request POST '[API ENDPOINT]/chain/whitelists/' --header 'Authorization: Bearer [YOUR_ACC_API_KEY]' --header 'Content-Type: application/json' --data-raw '<br/>[<br/> {<br/> "op_type":"add_entry",<br/> "kind":"developer", <br/> "entry":"0xe93685f3bBA03016F02bD1828BaDD6195988D951"<br/> }<br/>]'</pre>|
| **request example** | <pre lang="shell">curl --location --request POST '[API ENDPOINT]/chain/whitelists/' --header 'Authorization: Bearer [YOUR_ACC_API_KEY]' --header 'Content-Type: application/json' --data-raw '<br/>[<br/> `{<br/> "op_type":"add_entry",<br/> "kind":"developer", <br/> "entry":"0xe93685f3bBA03016F02bD1828BaDD6195988D951"<br/> \}`<br/>]'</pre>|
| **response example - success** | <pre lang="json">[<br/> "The entry: 0xe93685f3bBA03016F02bD1828BaDD6195988D951 has been added to the Developers whitelist successfully"<br/>]</pre>|
| **response examples - error** | Response Code: 400 Bad Request <pre lang="json">{<br/> "errorMessage":"engine request at index [1] is not authorized",<br/> "error":""<br/>}</pre>Note: not all error responses contain response body, but if response body exists it has the above format.<br/>|
| **response examples - error** | Response Code: 400 Bad Request <pre lang="json">`{<br/> "errorMessage":"engine request at index [1] is not authorized",<br/> "error":""<br/>}`</pre>Note: not all error responses contain response body, but if response body exists it has the above format.<br/>|
7 changes: 6 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const config = {
],

plugins: [
'./src/plugins/webpack-plugin.js',
[
require.resolve('@docusaurus/plugin-client-redirects'),
{
Expand Down Expand Up @@ -124,7 +125,11 @@ const config = {
label: 'GitHub',
position: 'right',
},
],
{label: 'Users', position: 'left', href: '/getting-started/overview'},
{label: 'Partners', position: 'left', href: '/launch-chain/introduction'},
{label: 'Developers', position: 'left', href: '/build-a-dapp/introduction'},
{label: 'Blog', position: 'right', href: '/blog'}
]
},
footer: {
style: 'dark',
Expand Down
33 changes: 24 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,41 @@
},
"dependencies": {
"@algolia/client-search": "^4.15.0",
"@docusaurus/core": "2.4.0",
"@docusaurus/plugin-client-redirects": "2.4.0",
"@docusaurus/preset-classic": "2.4.0",
"@docusaurus/theme-common": "2.4.0",
"@docusaurus/core": "3.5.2",
"@docusaurus/plugin-client-redirects": "3.5.2",
"@docusaurus/preset-classic": "3.5.2",
"@docusaurus/theme-common": "3.5.2",
"@fortawesome/fontawesome-svg-core": "^6.3.0",
"@fortawesome/free-brands-svg-icons": "^6.3.0",
"@fortawesome/react-fontawesome": "^0.2.0",
"@mdx-js/react": "^1.6.22",
"@types/react": "^17.0.48",
"@mdx-js/react": "^3.0.0",
"@types/react": "^18.2.0",
"clsx": "^1.2.1",
"docusaurus-plugin-sass": "^0.2.3",
"docusaurus-plugin-sass": "^0.2.5",
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react": "^18.2.0",
"react-cookie": "7.0.2",
"react-dom": "^17.0.2",
"react-dom": "^18.2.0",
"sass": "^1.59.3",
"sass-loader": "^13.2.1",
"typescript": "^5.0.2",
"webpack": "^5.76.3"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.0.0-beta.0",
"@types/node": "^22.3.0",
"dotenv": "^16.4.5",
"node-polyfill-webpack-plugin": "4.0.0",
"stream-http": "3.2.0"
},
"datoCMS": {
"highlight.js": "^11.7.0",
"highlightjs-solidity": "^2.0.6",
"@datocms/cma-client-node": "*",
"classnames": "2.3.2",
"date-fns": "^2.28.0",
"react-datocms": "^4.0.9"
},
"browserslist": {
"production": [
">0.5%",
Expand Down
Loading

0 comments on commit 07f29c9

Please sign in to comment.