Skip to content

Commit f118bd0

Browse files
feat(docs): Improve README with enhanced badges and social links (#812)
* feat(docs): Improve README with enhanced badges and social links * Update README.md * Update README.md --------- Co-authored-by: Greg Nazario <[email protected]>
1 parent 239f01b commit f118bd0

File tree

1 file changed

+108
-47
lines changed

1 file changed

+108
-47
lines changed

β€ŽREADME.md

+108-47
Original file line numberDiff line numberDiff line change
@@ -1,103 +1,164 @@
1-
# Developer Documentation
21

3-
- [Developer Documentation](#developer-documentation)
4-
- [Installation](#installation)
5-
- [Requirements](#requirements)
6-
- [Clone the Developer docs repo](#clone-the-developer-docs-repo)
7-
- [Install deps](#install-deps)
8-
- [Develop on Nextra (New)](#develop-on-nextra-new)
9-
- [Debugging](#debugging)
10-
- [Regenerating contributors](#regenerating-contributors)
112

12-
> Visit the `README.md` under `apps/nextra` for more steps on building / developing in this repo
3+
<p align="center">
4+
<img width="100%" src="https://github.com/aptos-labs/aptos-core/raw/main/.assets/aptos_banner.png" alt="Aptos Developer Docs">
5+
</p>
136

14-
We now use [lychee-broken-link-checker](https://github.com/marketplace/actions/lychee-broken-link-checker) to check for broken links in the GitHub Markdown. We use a corresponding link checker for pages on Aptos.dev.
7+
<div align="center">
8+
9+
[![Website](https://img.shields.io/badge/Website-Aptos.dev-0077b5?logo=internet-explorer&logoColor=white)](https://aptos.dev)
10+
[![Docs](https://img.shields.io/badge/Docs-4CAF50?logo=read-the-docs&logoColor=white)](https://aptos.dev/en/build/get-started)
11+
[![Discord](https://img.shields.io/badge/Join-Discord-5865F2?logo=discord&logoColor=white)](https://discord.com/invite/aptosnetwork)
12+
[![X (Twitter)](https://img.shields.io/badge/Follow-000000?logo=x&logoColor=white)](https://x.com/aptos)
13+
[![GitHub Issues](https://img.shields.io/github/issues/aptos-labs/developer-docs?color=yellow&logo=github)](https://github.com/aptos-labs/developer-docs/issues)
1514

1615
With results visible at:
1716
[https://github.com/aptos-labs/developer-docs/actions/workflows/links.yml](https://github.com/aptos-labs/developer-docs/actions/workflows/links.yml)
17+
</div>
1818

19-
## Installation
19+
---
2020

21-
**IMPORTANT**: These installation steps apply to MacOS environment.
21+
# πŸ“– **Aptos Developer Documentation**
2222

23-
### Requirements
23+
> Official **Aptos developer documentation**, providing everything you need to set up, develop, and test your projects.
2424
25-
Before you proceed, make sure you install the following tools.
25+
## πŸ“Œ **Table of Contents**
26+
- [πŸ’» Installation](#installation)
27+
- [βš™οΈ Requirements](#requirements)
28+
- [πŸ“‚ Clone the Repository](#clone-the-repository)
29+
- [πŸ“¦ Install Dependencies](#install-dependencies)
30+
- [πŸš€ Develop on Nextra](#develop-on-nextra)
31+
- [🐞 Debugging](#debugging)
32+
- [πŸ”„ Regenerating Contributors](#regenerating-contributors)
2633

27-
- Install [Node.js](https://nodejs.org/en/download/) by executing the below command on your Terminal:
34+
> πŸ“Œ **For additional instructions**, see the `README.md` inside `apps/nextra/`.
2835
29-
```sh
30-
brew install node
31-
```
36+
Aptos uses [lychee-broken-link-checker](https://github.com/marketplace/actions/lychee-broken-link-checker) to verify broken links in Markdown files.
3237

33-
- Install the latest [pnpm](https://pnpm.io/installation) by executing the below command on your Terminal:
38+
Results can be viewed here:
39+
πŸ”— [GitHub Actions: Link Checking](https://github.com/aptos-labs/developer-docs/actions/workflows/links.yml)
3440

35-
```sh
36-
curl -fsSL https://get.pnpm.io/install.sh | sh -
37-
```
41+
---
42+
43+
## πŸ’» **Installation**
44+
45+
### βš™οΈ **Requirements**
46+
Before you proceed, ensure you have installed the following dependencies:
47+
48+
- **Node.js**
49+
πŸ“Œ Install via Homebrew:
50+
```sh
51+
brew install node
52+
```
3853

39-
## Clone the Developer docs repo
54+
- **pnpm (package manager)**
55+
πŸ“Œ Install the latest version:
56+
```sh
57+
curl -fsSL https://get.pnpm.io/install.sh | sh -
58+
```
4059

60+
---
61+
62+
## πŸ“‚ **Clone the Repository**
4163
```sh
4264
git clone https://github.com/aptos-labs/developer-docs.git
4365
```
4466

45-
## Install deps
46-
47-
You may have to run the following command first if you are on macOS M1 Sonoma or newer:
67+
---
4868

69+
## πŸ“¦ **Install Dependencies**
70+
πŸ“Œ If you are using **macOS M1 Sonoma or later**, first run:
4971
```sh
5072
pnpm add node-gyp -g
5173
```
5274

53-
Then, run:
54-
75+
πŸ“Œ Then install all dependencies:
5576
```sh
5677
pnpm install
5778
```
5879

59-
## Develop on Nextra (New)
60-
61-
> Note: PLEASE SEE `apps/nextra/README.md` for more details!
80+
---
6281

63-
1. Setup environment
82+
## πŸš€ **Develop on Nextra**
83+
> ⚠ **Important**: For more details, see `apps/nextra/README.md`.
6484
65-
Ensure you have configured your `.env` properly under `apps/nextra/.env`. There is a `.env.example` there that you can duplicate and rename to `.env` for simplicity.
85+
### 1️⃣ **Set up the environment**
86+
πŸ“Œ Ensure your `.env` is properly configured inside `apps/nextra/.env`.
87+
Use `.env.example` as a template.
6688

67-
2. Build Nextra
89+
πŸ“Œ Validate the setup:
90+
```sh
91+
pnpm prebuild
92+
```
6893

94+
### 2️⃣ **Build Nextra**
6995
```bash
7096
pnpm run build
7197
```
98+
πŸ“Œ This command builds `apps/nextra` and all dependent local packages.
7299

73-
This will build `apps/nextra` and all local packages it depends on.
74-
75-
3. Run the development server
100+
### 3️⃣ **Navigate to the subdirectory**
101+
```sh
102+
cd apps/nextra
103+
```
76104

105+
### 4️⃣ **Run the local development server**
77106
```sh
78107
pnpm run dev
79108
```
109+
πŸ“Œ Server will be available at:
110+
πŸ”— **[http://localhost:3000](http://localhost:3000)**
80111

81-
## Debugging
82-
83-
Fix formatting issues by running:
112+
---
84113

114+
## 🐞 **Debugging**
115+
πŸ“Œ Fix formatting issues by running:
85116
```sh
86117
pnpm fmt
87118
```
88119

89-
## Regenerating contributors
120+
---
90121

91-
The `src/contributors.json` file (which powers the list of Authors at the bottom of doc pages) needs to be manually generated.
122+
## πŸ”„ **Regenerating Contributors**
123+
πŸ“Œ The `src/contributors.json` file (which powers the author list at the bottom of doc pages) needs manual updates.
92124

93-
In order to generate the contributor map, you must authenticate with GitHub. The best way to do that is using GitHub CLI [installation guide](https://github.com/cli/cli#installation). Once you have the GitHub CLI installed, you can run the following command to authenticate:
125+
### 1️⃣ **Authenticate with GitHub**
126+
πŸ“Œ Install **GitHub CLI**:
127+
πŸ”— [Installation Guide](https://github.com/cli/cli#installation)
94128

129+
πŸ“Œ Log into your GitHub account:
95130
```sh
96131
gh auth login --scopes read:user,user:email
97132
```
98133

99-
Once that is done, you can generate the map with this command:
100-
134+
### 2️⃣ **Generate the contributor list**
101135
```sh
102136
pnpm contributors
103-
```
137+
```
138+
πŸ“Œ The updated list will now appear in the documentation.
139+
140+
---
141+
142+
## πŸ”— **Useful Links**
143+
[![Website](https://img.shields.io/badge/Website-Aptos.dev-0077b5?logo=internet-explorer&logoColor=white&style=for-the-badge)](https://aptos.dev)
144+
[![Docs](https://img.shields.io/badge/Docs-4CAF50?logo=read-the-docs&logoColor=white&style=for-the-badge)](https://aptos.dev/en/build/get-started)
145+
[![Discord](https://img.shields.io/badge/Join-Discord-5865F2?logo=discord&logoColor=white&style=for-the-badge)](https://discord.com/invite/aptosnetwork)
146+
[![X (Twitter)](https://img.shields.io/badge/Follow-000000?logo=x&logoColor=white&style=for-the-badge)](https://x.com/aptos)
147+
[![GitHub Discussions](https://img.shields.io/badge/GitHub-Discussions-181717?logo=github&logoColor=white&style=for-the-badge)](https://github.com/aptos-labs/developer-docs/discussions)
148+
149+
150+
---
151+
152+
## πŸ“œ **License**
153+
This project is licensed under the **Apache 2.0**.
154+
See [`LICENSE`](LICENSE) for more details.
155+
156+
---
157+
158+
## 🀝 **Contributors**
159+
A huge thank you to everyone who has contributed to this project! πŸ™Œ
160+
161+
<a href="https://github.com/aptos-labs/developer-docs/graphs/contributors">
162+
<img src="https://contrib.rocks/image?repo=aptos-labs/developer-docs" />
163+
</a>
164+

0 commit comments

Comments
Β (0)