From 0385652d3c012d51bfa83c05a459c31c44777423 Mon Sep 17 00:00:00 2001 From: Megan Skye <58894568+meganskye@users.noreply.github.com> Date: Tue, 3 Oct 2023 17:54:50 -0700 Subject: [PATCH] update docs integration request doc (#454) --- docs-integration-request.md | 78 +++++++++++++++++++++++++ docs/getting-started.md | 16 ++--- infrastructure_pull_request_template.md | 38 ------------ 3 files changed, 86 insertions(+), 46 deletions(-) create mode 100644 docs-integration-request.md delete mode 100644 infrastructure_pull_request_template.md diff --git a/docs-integration-request.md b/docs-integration-request.md new file mode 100644 index 00000000000..b0ebbc90f52 --- /dev/null +++ b/docs-integration-request.md @@ -0,0 +1,78 @@ +--- +title: Docs Integration Request Form +--- + +# Your Project Name + +:::info +- Create a new branch of astar-docs for your update/addition. + +- Within the new branch, copy and rename this file to something meaningful (ie: *projectname-oracle.md* or *widgetzyx-nft-api.md*) and move it to the most appropriate section of Astar docs. If you're unsure about where that might be in the end, please submit a PR anyways; we will find a home for it prior to merging. + +- If your tutorial includes images or screenshots, which are **highly encouraged**, please add them to a new or existing `img` folder located within the same folder as your .md file, and link to them using the following: + + At top of .md file add this exactly: + + `import Figure from '/src/components/figure'` + + and in reference to each image, as one example: + + `
` + + or another example without a caption; width reduced: + + `
` + +- When your document or tutorial is finished, submit a pull request to the [astar-docs](https://github.com/AstarNetwork/astar-docs) repo on Github. Thank you! +::: + +## Introduction + +Write a short description in just a few paragraphs about your solution and how Astar developers can leverage it. + +#### Example: +GraphQL is a query language for APIs and a runtime for executing those queries with your existing data. It provides an efficient and powerful alternative to REST and offers significant advantages when dealing with complex data models. + +GraphQL allows clients to define the structure of the responses they receive. This means that instead of receiving a fixed data structure from a server, clients can request specific data they need, leading to more efficient data loading and a reduction in data over-fetching. + +## Prerequisites + +List the prerequisites necessary to work with your solution. Mention all required libraries, SDKs, plugins, etc. and the corresponding versions that should be installed, in list format. Link to external documentation if necessary. + +#### Example: + - The latest version of `[Node.js](https://link.to.download.com)`. + - Swanky v1.x.x.x. + - A local development node. + - Basic JavaScript knowledge. + +## Getting started + +Here you should provide a step-by step tutorial about how developers can use your solution on Astar. + +### Step 1 +### Step 2 +### Step... + +## Addresses/Endpoints + +Here you can provide a list of Gateways, Endpoints, or any other supporting information, in list form. Feel free to change the name of this heading to something more appropriate, or remove it entirely. + +## Troubleshooting +List common implementation issues, causes, and solutions. + +#### Example: +**I receive Error *X* after running *Y*** + +This occurs due to *Z* which can be resolved by following *ABC.* + +:::note +This *something* is for **advanced users**, only. +::: + +:::danger +This *something* you **REALLY** don't want to do!! +::: + +## Learn more + +Here you can provide links to your own documentation and related resources. diff --git a/docs/getting-started.md b/docs/getting-started.md index 7a34a214e1c..3597688c13a 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -4,16 +4,16 @@ sidebar_position: 1 # Getting Started -Astar is the largest smart contract platform in the Polkadot ecosystem, supporting both Wasm and EVM. While providing native access to the Polkadot ecosystem through it's parachain slot, Astar also has bridges into other major ecosystems, including [Ethereum][cbridge], [BSC][cbridge], Cosmos, Polygon, and more. Through the #Build2Earn program, Astar offers a basic income to dApp developers through inflation, and provides direct funding to projects through the Astar Incubation Program. +Astar is the largest smart contract platform in the Polkadot ecosystem, supporting both Wasm and EVM. While providing native access to the Polkadot ecosystem through it's parachain slot, Astar also has bridges into other major ecosystems, including [Ethereum][cbridge], [BSC][cbridge], Cosmos, Polygon, and more. Through the #Build2Earn program, Astar offers a basic income to dApp developers, and direct funding to projects through an *unstoppable grants* program. ## Overview of Docs -- [**Build**](/docs/build) gives you the resources you need to get started with building. - testing, deploying, and interacting with smart contracts on the network. -- [**EVM**](/docs/build/evm) dives deeper into EVM on Astar and explains how EVM contracts can interact with other non-EVM modules through [precompiles](https://docs.astar.network/docs/build/EVM/precompiles/). -- [**Wasm**](/docs/build/wasm) provides an overview of the [Wasm stack](https://docs.astar.network/docs/build/wasm/smart-contract-wasm) on Astar, [Wasm contract frameworks](/docs/build/wasm/dsls), and [Swanky Suite](/docs/build/wasm/swanky-suite/). -- [**Nodes**](/docs/build/nodes) explains how to run full nodes, collators, indexers, and everything you need to know related to infrastructure. -- [**XCM**](/docs/learn/interoperability/xcm) explains how XCM is used in Astar and also how developers can use it to interact with the rest of the Polkadot network. -- [**Integrations**](/docs/build/integrations/) provide relevant information about the wallets, indexers, and oracles that are integrated with the network. +- [**Build**](/docs/build) - Provides the resources you need to start building, testing, deploying, and interacting with smart contracts on Astar network. +- [**EVM**](/docs/build/evm) - Dives deeper into the EVM on Astar and explains how EVM smart contracts can interact with non-EVM modules and the Wasm virtual machine through [precompiles](https://docs.astar.network/docs/build/EVM/precompiles/). +- [**Wasm**](/docs/build/wasm) - Provides an overview of the [Wasm stack](https://docs.astar.network/docs/build/wasm/smart-contract-wasm) on Astar, [Wasm contract frameworks](/docs/build/wasm/dsls), and [Swanky Suite](/docs/build/wasm/swanky-suite/). +- [**Nodes**](/docs/build/nodes) - Explains how to run full nodes, collators, indexers, and everything else related to infrastructure. +- [**XCM**](/docs/learn/interoperability/xcm) - Explains how XCM is used in Astar and also how developers can use it to interact with the rest of the Polkadot network. +- [**Integrations**](/docs/build/integrations/) - Provides relevant information about the wallets, indexers, and oracles that are integrated with the network. +- [**Docs Integration Request**](https://github.com/AstarNetwork/astar-docs/blob/main/docs-integration-request.md) - Provides information about how to make a documentation integration request. [cbridge]: https://cbridge.celer.network/#/transfer diff --git a/infrastructure_pull_request_template.md b/infrastructure_pull_request_template.md deleted file mode 100644 index c99b3895c44..00000000000 --- a/infrastructure_pull_request_template.md +++ /dev/null @@ -1,38 +0,0 @@ -# Name of the Project -## Introduction - - -// Write no more than 2 paragraphs about your solution and how Astar developers can leverage it. - -## Prerequisites - -// List all the prerequisites for developers to work with your tool. -// Mention all the libraries, SDKs that need to be installed. Keep prerequisites short in the list format, and link to your documentation if necessary. - -Example: - - Have the latest Node version installed (link to node documentation) - - Have your local development node running - - Basic JavaScript knowledge - -## Getting started - -Provide step-by step tutorial on how to use your tool with Astar. -### Step 1 -### Step 2 -### Step... - -## Addresses/Endpoints - -If you provide list of Addressess (bridges) or Endpoints or any other necessary listings, use this section to list them. Feel free to change the heading, but keep it short. - -## Troubleshooting -// List all the common problems and solutions to them - -Example: -**I receive Error X when I run Z** -This happens because... Do XYZ. - - -## Learn more - -List the links to your documentation and any other resources you find are necessary.