Skip to content

Commit a37ad8f

Browse files
committed
improving & simpyfying contribution guidelines
1 parent 7293c35 commit a37ad8f

File tree

1 file changed

+10
-57
lines changed

1 file changed

+10
-57
lines changed

CONTRIBUTING.md

+10-57
Original file line numberDiff line numberDiff line change
@@ -2,48 +2,10 @@
22

33
The Documentation team at Avail are the primary maintainers of the Avail Documentation and will review all issues and pull requests created in this repository.
44

5+
| ℹ️ Please make sure to create an issue outlining your feedback/content request for the docs before creating a PR.
6+
PRs created without approval will be rejected. We are open to technical articles on a wide variety of topics related to Avail and Web3 in general. If you have something in mind, please feel free to jump in with an issue on the repo.|
57
<!-- TOC -->
68

7-
- [Contribution Guidelines](#contribution-guidelines)
8-
- [Ways to Contribute to the Avail Documentation](#ways-to-contribute-to-the-avail-documentation)
9-
- [How to Contribute Changes via the Avail Documentation Website](#how-to-contribute-changes-via-the-avail-documentation-website)
10-
- [How to Locally Run the Avail Documentation](#how-to-locally-run-the-avail-documentation)
11-
- [Quick Run](#quick-run)
12-
- [Setup Steps](#setup-steps)
13-
- [License](#license)
14-
<!--/ TOC -->
15-
16-
## Ways to Contribute to the Avail Documentation
17-
18-
If you spot typos or grammar mistakes, please go ahead and submit a pull request with the fixes. For more significant changes, it's advisable to start with a GitHub issue to discuss it with the maintainers. We generally prefer pull requests over issues for suggesting changes to the Docs.
19-
20-
| ❗ We are in the process of setting guidelines to ensure all new contributions continue to improve the Docs without compromising its quality. Please stay tuned. |
21-
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22-
23-
Before making a contribution, please consult any existing issues or initiate a new discussion to ensure alignment with the documentation's objectives.
24-
Your contributions can significantly enrich the Docs in the following ways:
25-
26-
1. **General Overviews**: Introductory articles that provide a comprehensive understanding of Avail's data availability layer and modular approach to blockchains.
27-
28-
2. **Technical Deep Dives**: Detailed explorations into specific components of Avail's architecture, such as its data availability layer, modularity, and consensus algorithms.
29-
30-
3. **Use-Case Scenarios**: Articles that showcase real-world applications of Avail in solutions like validiums, appchains, and sovereign rollups.
31-
32-
4. **Tooling**: Documentation or guides on tools that facilitate development, testing, or deployment on Avail. This could include IDE plugins, testing frameworks, or monitoring tools.
33-
34-
5. **Third-Party Services and Deployments**: Information on external services, deployments, and implementations that integrate with Avail. This could include oracles, data analytics platforms, liquidity providers, as well as infrastructure solutions that provide Avail-based infrastructure.
35-
36-
6. **Community Contributions**: Lists of active Avail communities, educational resources, or upcoming events that enrich the ecosystem.
37-
38-
7. **Governance & Economics**: Insights into the governance model and tokenomics that underpin Avail's network.
39-
40-
8. **Security Practices**: Guidelines and resources for ensuring the security and integrity of applications, smart contracts, and general infrastructure on Avail.
41-
42-
9. **Troubleshooting Guides**: Solutions to common challenges, FAQs, and other resources that assist both newcomers and experienced users.
43-
44-
10. **Emerging Technologies**: Articles on upcoming features, advancements, or experimental technologies in the Avail pipeline. For instance, contributions could explore the impact of "Dank Sharding" on Avail's scalability, transaction costs, and its enablement of new decentralized applications.
45-
46-
> Note: This is a general overview and the actual repository may contain additional files and folders for specific functionalities.
479

4810
## How to Contribute Changes via the Avail Documentation Website
4911

@@ -62,33 +24,22 @@ Contributing to the Avail Documentation is simple. You'll need a GitHub account
6224

6325
## How to Locally Run the Avail Documentation
6426

65-
### Quick Run
66-
67-
For those who want to quickly install and start the Avail Documentation locally, you can follow these steps:
68-
69-
```bash
70-
npm i
71-
npm run build
72-
npm start
73-
```
74-
75-
### Setup Steps
76-
7727
> **Prerequisites**:
7828
>
7929
> - [Node.js](https://nodejs.org/en/download/) (version >= 16.14.1)
8030
> - [pnpm](https://pnpm.io/installation)
8131
> **Note for macOS Users**: Xcode and Command Line Tools are required.
8232
83-
1. **Fork the Repository**
33+
1. **Fork the repository**
8434

8535
> See [GitHub Docs: Fork a repo](https://help.github.com/en/articles/fork-a-repo) for guidance.
8636
87-
2. **Clone Your Fork**
37+
2. **Clone your fork**
8838

8939
```bash
90-
git clone git@github.com:availproject/docs.git
40+
git clone https://github.com/Genesis3800/docs.git
9141
```
42+
This will create a repo named `docs` in your current directory.
9243

9344
3. **Navigate to the Repository**
9445

@@ -104,6 +55,8 @@ npm start
10455
git remote add upstream https://github.com/availproject/docs
10556
```
10657

58+
| ℹ️ You can check if the upstream was added correctly by running `git remote -v`.|
59+
10760
5. **Sync Your Fork**
10861

10962
> See [GitHub Docs: Syncing a fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork).
@@ -117,15 +70,15 @@ npm start
11770
6. **Install Dependencies**
11871

11972
```bash
120-
npm install
73+
pnpm install
12174
```
12275

12376
The site is built using Nextra.
12477

12578
7. **Run the Docs Locally**
12679

12780
```bash
128-
npm run dev
81+
pnpm run dev
12982
```
13083

13184
This will start a local dev derver at `http://localhost:3000` on your machine.

0 commit comments

Comments
 (0)