Skip to content

Commit 7f603fb

Browse files
dineshpinto0xreflexivity
authored andcommitted
fix(docs): update readme and contributing guide
1 parent b36707d commit 7f603fb

File tree

2 files changed

+13
-16
lines changed

2 files changed

+13
-16
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing Guidelines
22

3-
Thank you for helping improve **Flare Developer Hub**!
3+
Thank you for helping improve the **Flare Developer Hub**!
44
Your contributions make our documentation, tooling, and examples better for everyone.
55

66
We welcome:
@@ -10,7 +10,7 @@ We welcome:
1010

1111
## 🛠 Development Workflow
1212

13-
1. **Fork and branch:** Fork the repo on GitHub and create a branch for your work:
13+
1. **Fork and branch:** Create a branch for your work:
1414

1515
```bash
1616
git checkout -b feature/your-feature-name
@@ -20,7 +20,7 @@ We welcome:
2020
- Documentation (`docs/`)
2121
- Source code (`src/`)
2222
- Examples (`examples/`)
23-
- automation and docgen scripts (`automations/`, `docgen/`)
23+
- automation scripts (`automations/`, `docgen/`)
2424

2525
3. **Follow Style Guides:**
2626
- **Code/Docs:** Run [Pre-PR checks](#pre-pr-checks). Match existing code style.
@@ -66,13 +66,13 @@ We welcome:
6666
- ✅ **Provide Context:** Describe the problem, solution, and link related issues.
6767
- ✅ **Pass CI:** Fix any GitHub Actions failures before requesting review.
6868
- ✅ **Update Docs:** If behavior or usage changes.
69-
- ✅ **Confirm Licensing:** All PRs are submitted under this repo’s [license](LICENSE).
69+
- ✅ **Confirm Licensing:** All PRs are submitted under this repo’s license.
7070

7171
## <a id="pre-pr-checks"></a>🔍 Pre-PR Checks
7272

7373
Run these before submitting a PR:
7474

75-
1. **Build & check internal links:**
75+
1. **Build & verify internal links:**
7676

7777
```bash
7878
npm run build
@@ -90,15 +90,15 @@ Run these before submitting a PR:
9090
lychee --config lychee.toml .
9191
```
9292

93-
4. **If you modified examples**, run their formatters and tests, see `examples/developer-hub-*/README.md` for more instructions.
94-
Example for Rust:
93+
4. **If you modified examples**, run their formatters/tests:
94+
(example for Rust, see `examples/developer-hub-*/README.md` for more instructions)
9595

9696
```bash
9797
cd examples/developer-hub-rust/
9898
cargo fmt -- --check # Format
9999
cargo clippy --bins -- -D warnings # Lint
100100
cargo build --bins --locked # Build
101-
chmod +x test.sh && ./test.sh # Test
101+
chmod +x test.sh && ./test.sh # Tes
102102
```
103103

104104
## <a id="diagrams-style-guide"></a>🖼 Diagrams Style Guide

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ This repository contains the source code and content for the [Flare Developer Hu
44

55
This site is built with [Docusaurus](https://docusaurus.io/), a modern static site generator.
66

7-
> **Note:**
8-
> This README is for contributors to Developer Hub.
9-
> If you just want to read the docs, visit [dev.flare.network](https://dev.flare.network).
7+
> **Note:** This README is for contributors to the Developer Hub source.
8+
> If you just want to read the documentation, visit [dev.flare.network](https://dev.flare.network).
109
1110
## 🚀 Getting Started
1211

@@ -87,8 +86,7 @@ Language-specific examples use their native formatters:
8786
- Rust →`cargo fmt` for Rust
8887
- Python → `ruff` for Python
8988

90-
> **Note:**
91-
> Prettier support for MDXv3 is evolving ([tracking issue](https://github.com/prettier/prettier/issues/12209)).
89+
> **Note:** Prettier support for MDXv3 is evolving ([tracking issue](https://github.com/prettier/prettier/issues/12209)).
9290
> To skip formatting for a section:
9391
>
9492
> ```plaintext
@@ -124,7 +122,7 @@ To generate Solidity documentation:
124122

125123
1. **Update addresses and feeds:**
126124

127-
Fetches latest contract addresses from `ContractRegistry` and feed data for use in tables and components.
125+
Fetches latest contract addresses from `ContractRegistry` and feed data for use in site tables and components.
128126

129127
```bash
130128
npm run automations
@@ -133,7 +131,6 @@ To generate Solidity documentation:
133131
2. **Update language dependencies:**
134132

135133
Updates dependencies in all `examples/*` subdirectories.
136-
Use with caution, run all test suites after updating.
137134

138135
```bash
139136
npm run update-deps
@@ -148,4 +145,4 @@ We welcome contributions of all sizes - from typo fixes to major feature additio
148145
```bash
149146
git checkout -b feature/my-change
150147
```
151-
3. Commit and push your changes, and open a PR.
148+
3. Commit, push, and open a PR.

0 commit comments

Comments
 (0)