Skip to content

Commit 2b736d2

Browse files
authored
Update README.md
1 parent 7d74152 commit 2b736d2

File tree

1 file changed

+30
-19
lines changed

1 file changed

+30
-19
lines changed

README.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,58 @@
11
# lychee Documentation
22

3-
This is the source code for the official documentation page of [lychee](https://github.com/lycheeverse/lychee/).
3+
This is the source code for the official documentation of [lychee](https://github.com/lycheeverse/lychee/), a fast, async link checker.
44

55
[![Links](https://github.com/lycheeverse/lycheeverse.github.io/actions/workflows/check-links.yml/badge.svg)](https://github.com/lycheeverse/lycheeverse.github.io/actions/workflows/check-links.yml)
66
[![Code Quality](https://github.com/lycheeverse/lycheeverse.github.io/actions/workflows/check-code-quality.yml/badge.svg)](https://github.com/lycheeverse/lycheeverse.github.io/actions/workflows/check-code-quality.yml)
77
[![PR Links](https://github.com/lycheeverse/lycheeverse.github.io/actions/workflows/check-pr-links.yml/badge.svg)](https://github.com/lycheeverse/lycheeverse.github.io/actions/workflows/check-pr-links.yml)
88
[![Deploy](https://github.com/lycheeverse/lycheeverse.github.io/actions/workflows/deploy.yml/badge.svg)](https://github.com/lycheeverse/lycheeverse.github.io/actions/workflows/deploy.yml)
99
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
1010

11-
## Getting Started
11+
## Quick Start
1212

13-
To clone the repository, run
13+
### Prerequisites
14+
15+
- [Node.js](https://nodejs.org/) (v18+)
16+
- [pnpm](https://pnpm.io/) package manager
17+
18+
### Development
1419

1520
```bash
21+
# Clone the repository
1622
git clone https://github.com/lycheeverse/lycheeverse.github.io.git
1723
```
1824

19-
## Installation
20-
21-
To install the dependencies, run
22-
2325
```bash
26+
# Install dependencies
2427
pnpm install
2528
```
2629

27-
## Local Development
28-
29-
To start the development server, run
30-
3130
```bash
31+
# Start local dev server
3232
pnpm dev
3333
```
3434

35-
## Raise an Issue
35+
## Contributing
36+
37+
We welcome contributions! Here's how to help:
38+
39+
### Report Issues
3640

37-
Is something missing?
38-
Is something confusing?
39-
Is something wrong?
41+
Found a problem? Check if it's already been reported in our [issues](https://github.com/lycheeverse/lycheeverse.github.io/issues). If not, [create a new issue](https://github.com/lycheeverse/lycheeverse.github.io/issues/new/choose).
4042

41-
[See if your issue has already been reported](https://github.com/lycheeverse/lycheeverse.github.io/issues), and if not, [create a new one](https://github.com/lycheeverse/lycheeverse.github.io/issues/new/choose).
43+
### Submit Changes
4244

43-
## Make a Fix or Contribution
45+
1. Fork the repository
46+
2. Create a feature branch
47+
3. Make your changes (fix typos, broken links, etc.)
48+
4. Submit a pull request
4449

45-
Did you find a typo, a broken link, or another item with an obvious quick fix?
50+
## Project Structure
4651

47-
If you can see what the problem is, and you know how to fix it, then you can make a PR (pull request) with the change and contribute to the docs repo yourself.
52+
```
53+
├── src/
54+
│ ├── assets/ # Images and static files
55+
│ └── content/ # Documentation pages (Markdown/MDX)
56+
├── astro.config.mjs # Astro configuration
57+
└── package.json
58+
```

0 commit comments

Comments
 (0)