Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/content-update-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Content Update Request
description: Report incorrect, outdated, or incomplete content in the Astar documentation
title: "[Content Update] "
labels: ["content update"]
body:
- type: markdown
attributes:
value: |
Use this template to flag content that is wrong, outdated, or missing important information.
For small fixes like typos or broken links, you may open a pull request directly without an issue.

- type: input
id: page-url
attributes:
label: Page URL or File Path
description: Link to the documentation page or the file path in the repository
placeholder: https://docs.astar.network/docs/... or docs/path/to/file.md
validations:
required: true

- type: textarea
id: current-content
attributes:
label: Current Content
description: Copy the text or describe the section that needs updating
validations:
required: true

- type: textarea
id: proposed-change
attributes:
label: Proposed Change
description: Describe what the correct or updated information should be
validations:
required: true

- type: input
id: source
attributes:
label: Source or Reference
description: Link to an official source confirming the correct information (strongly recommended)
placeholder: https://official-docs-or-announcement-link
104 changes: 104 additions & 0 deletions .github/ISSUE_TEMPLATE/new-integration-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
name: New Integration or Tooling Request
description: Request the inclusion of a new project, tool, or integration in the Astar documentation
title: "[Integration Request] "
labels: ["integration request", "documentation"]
body:
- type: markdown
attributes:
value: |
Thank you for your interest in being documented in the Astar docs.
Please complete all fields accurately. Incomplete requests or projects that do not meet the eligibility criteria will be closed without review.
Before submitting, confirm your project is live on **Astar Network mainnet**.

- type: input
id: project-name
attributes:
label: Project Name
description: The official name of your project or tool
placeholder: e.g. CometSwap
validations:
required: true

- type: dropdown
id: category
attributes:
label: Category
description: Select the category that best describes your project
options:
- Bridge
- DEX / AMM
- Lending / Borrowing
- Wallet
- Oracle
- NFT Marketplace
- Infrastructure / RPC
- Developer Tooling
- Analytics
- Other
validations:
required: true

- type: input
id: deployment-url
attributes:
label: Live Deployment URL
description: The URL of your live Astar Network mainnet deployment or service
placeholder: https://yourproject.app
validations:
required: true

- type: input
id: official-website
attributes:
label: Official Website
placeholder: https://yourproject.com
validations:
required: true

- type: input
id: github-repo
attributes:
label: GitHub Repository (if open source)
placeholder: https://github.com/yourorg/yourrepo

- type: input
id: docs-section
attributes:
label: Proposed Documentation Section
description: Which section of the docs should your project appear in?
placeholder: e.g. docs/use/integrations or docs/build/tooling
validations:
required: true

- type: textarea
id: description
attributes:
label: Project Description
description: A concise, factual description of what your project does and how it relates to the Astar ecosystem. Maximum 300 words. No marketing language.
validations:
required: true

- type: textarea
id: why-include
attributes:
label: Why should this be included?
description: Explain the value this documentation provides to Astar Network developers or users
validations:
required: true

- type: checkboxes
id: checklist
attributes:
label: Eligibility Checklist
description: All items must be confirmed before your request will be reviewed
options:
- label: My project is live on Astar Network mainnet (not testnet only)
required: true
- label: My project is actively maintained
required: true
- label: This documentation does not already exist in these docs
required: true
- label: I am authorized to represent this project
required: true
- label: I have read the CONTRIBUTING.md guidelines
required: true
30 changes: 30 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Description

<!-- Summarize the changes in this PR -->

## Type of Change

- [ ] Bug fix (typo, broken link, outdated information)
- [ ] New integration or tooling documentation
- [ ] New tutorial or guide
- [ ] Structural or navigation improvement
- [ ] Other

## Linked Issue

Closes #<!-- issue number, required for new integrations -->

## Checklist

- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines
- [ ] The build passes locally (`yarn build`)
- [ ] All links in changed files are working
- [ ] Images use the `<Figure>` component with absolute paths
- [ ] Content is factual and contains no marketing language
- [ ] The file structure follows the existing documentation hierarchy

## For New Integration PRs Only

- [ ] The project is live on Astar Network mainnet
- [ ] An approved integration request issue exists (Issue #___)
- [ ] Page structure follows the existing format for this category
153 changes: 153 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
# Contributing to Astar Documentation

Thank you for your interest in contributing to the Astar documentation. This guide explains who can contribute, what standards apply, and the process for getting new integrations or tooling listed.

## Types of Contributions

| Type | Description |
| --- | --- |
| **Bug fix** | Correcting typos, broken links, or factually incorrect information |
| **Content update** | Updating outdated instructions, screenshots, or network parameters |
| **New tutorial** | Adding a step-by-step guide for using a feature or tool in the Astar ecosystem |
| **New integration** | Requesting that a partner project, protocol, or developer tool be documented |
| **Structural improvement** | Reorganizing content for clarity without changing the underlying information |

All contributions go through a pull request and require at least one approval from the Astar documentation team before merging.

## Partner and Tooling Inclusion

This section is specifically for teams or individuals who want to get a project, protocol, or tool documented in the Astar docs.

### Eligibility Criteria

Before opening a request, your project must meet all of the following:

- **Live on mainnet.** Your project must be deployed and functional on Astar Network. Testnet-only projects are not accepted.
- **Actively maintained.** The project must show recent activity. Abandoned or deprecated projects will not be added and existing ones may be removed.
- **Not a duplicate.** The documentation you are proposing must not already exist or substantially overlap with existing content.
- **Factual and technical.** The documentation must describe how to use or integrate the product. Marketing copy, price information, and investment language are not accepted.
- **Authorized submission.** You must be an official representative of the project or have explicit permission to submit documentation on its behalf.

### The Two-Stage Process

New integration documentation follows a proposal-first workflow. A PR submitted without an approved issue will be closed.

#### Stage 1: Open an Integration Request Issue

Use the [New Integration Request](https://github.com/AstarNetwork/astar-docs/issues/new/choose) issue template. You will be asked to provide:

- Project name and category
- Live deployment or service URL on Astar Network
- Official website and GitHub repository (if open source)
- The section of the docs where your content belongs
- A factual description of what the project does

The documentation team will review the request within **5 business days** and respond with one of the following:

- **Approved**: You are invited to open a PR with the documentation
- **Needs more information**: The team will request clarification before making a decision
- **Declined**: The request does not meet the eligibility criteria; a reason will be provided

#### Stage 2: Open a Pull Request

Once your issue is approved, open a PR that:

- References the approved issue number in the description
- Follows the file structure and style guide described below
- Passes a local build check (`yarn build`); a maintainer will verify the build passes before merging
- Uses the PR template checklist

### What Happens After Your PR Is Submitted

1. **Build and link checks**: a maintainer will verify the build passes and links resolve
2. **Content review** by the documentation team checks accuracy, tone, and structure
3. **One approval** is required from a team member before merge
4. Once merged, the content appears on [docs.astar.network](https://docs.astar.network) within minutes

## Documentation Standards

### File Structure

Place new documentation files in the correct section of the `docs/` directory. Follow the existing hierarchy:

```
docs/
build/ Developer tools, integrations, EVM/WASM guides
use/ End-user guides: wallets, bridges, dApp staking
learn/ Conceptual content: architecture, tokenomics
```

If you are unsure where your content belongs, ask in the linked issue before creating files.

### Page Structure

Every new page should include:

1. **Frontmatter** with at minimum `sidebar_position`; a `title` field is recommended but not required
2. **Overview paragraph** explaining what the page covers and who it is for
3. **Prerequisites** (if applicable) listing what the reader needs before starting
4. **Step-by-step content** using numbered lists for sequential actions
5. **Troubleshooting or notes** (if applicable) using Docusaurus admonition blocks (`:::info`, `:::caution`, `:::warning`)

### Writing Style

- Write in the **second person** ("you", "your") and **present tense**
- Use **active voice**: "Click the button" not "The button should be clicked"
- Keep sentences short. One idea per sentence
- Spell out acronyms on first use: "Decentralized Exchange (DEX)"
- Do not include prices, APY, TVL, or other figures that change over time
- Do not include referral links or promotional language

### Images

Always use the `<Figure>` component instead of standard markdown image syntax. This ensures proper rendering across all locales.

**Import at the top of the file:**
```jsx
import Figure from '/src/components/figure'
```

**Usage:**
```jsx
<Figure
src={require('/docs/your-section/img/your-image.png').default}
caption="A description of the image"
width="100%"
/>
```

Use **absolute paths** for images. Relative paths will break when content is reorganized.

### Code Blocks

Always specify the language for syntax highlighting:

````markdown
```typescript
const example = "always add the language"
```
````

## Updating Existing Documentation

To report or correct outdated, incorrect, or incomplete content, open a [Content Update Request](https://github.com/AstarNetwork/astar-docs/issues/new/choose) issue. Include:

- The URL or file path of the page in question
- The current content that needs changing
- The proposed correction and a source or reference confirming it

For small corrections (typos, broken links), you may open a PR directly without an issue.

## Review SLA

| Action | Expected Response Time |
| --- | --- |
| New integration request issue review | 5 business days |
| Content update issue review | 3 business days |
| PR review after CI passes | 3 business days |

If you have not received a response within these timeframes, feel free to leave a comment on your issue or PR as a reminder.

## Questions

For questions about the contribution process, reach out via the [Astar Discord](https://discord.gg/astarnetwork) in the `#documentation` channel, or open a GitHub Discussion.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,52 @@ git push origin main

</details>

## Partner and Tooling Contributions

If you represent a project, protocol, or developer tool deployed on **Astar Network** and want it documented here, follow the process below. Direct PRs without a prior approved issue will be closed.

<details>
<summary><b>How to Request Inclusion</b></summary>

### Step 1: Check Eligibility

Your project must meet all of the following before opening a request:

* **Live on Astar Network mainnet** (testnet-only projects are not accepted)
* **Actively maintained** (recent activity required)
* **Not already documented** in these docs
* **Technical and factual** content only (no marketing copy, prices, or APY figures)
* **You are authorized** to submit documentation on behalf of the project

### Step 2: Open an Integration Request Issue

Go to the [Issues tab](https://github.com/AstarNetwork/astar-docs/issues/new/choose) and select **New Integration or Tooling Request**. You will be asked to provide:

* Project name and category
* Live deployment or service URL on Astar Network
* Official website and GitHub repository (if open source)
* The section of the docs where your content belongs
* A factual description of what the project does and why it belongs here

The documentation team will review your request within **5 business days** and respond with one of the following outcomes:

* **Approved** — you are invited to open a PR with the documentation
* **Needs more information** — the team will ask for clarification
* **Declined** — the request does not meet the criteria; a reason will be given

### Step 3: Open a Pull Request

Once your issue is approved, open a PR from a fork of this repository. Your PR must:

* Reference the approved issue number
* Follow the file structure and style described in [CONTRIBUTING.md](CONTRIBUTING.md)
* Pass a local build check (`yarn build`); a maintainer will verify this before merging
* Use the PR checklist template

See [CONTRIBUTING.md](CONTRIBUTING.md) for the complete documentation standards, writing style guide, and review process.

</details>

## Working with Images

Please import and use the `<Figure/>` tag instead of `![image]` as this enables smoother translation of docs to other languages (automatic reference to original images, no need to copy images to translated subfolders) and automatically applies some styling such as line breaks.
Expand Down
Loading