From 072f7e2a68e6a6bb33125aa826db244a0419c238 Mon Sep 17 00:00:00 2001 From: Matthias Date: Thu, 11 Jun 2026 12:49:04 +0200 Subject: [PATCH 1/3] Trim fluff from README --- README.md | 36 +++++++----------------------------- 1 file changed, 7 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 3cb800a..e750902 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # lychee Documentation -This is the source code for the official documentation of [lychee](https://github.com/lycheeverse/lychee/), a fast, async link checker. +Source for the official documentation of [lychee](https://github.com/lycheeverse/lychee/), a fast, async link checker. [![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) [![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) @@ -8,44 +8,22 @@ This is the source code for the official documentation of [lychee](https://githu [![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) [![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) -## Quick Start +## Development -### Prerequisites - -- [Node.js](https://nodejs.org/) (v18+) -- [pnpm](https://pnpm.io/) package manager - -### Development +Requires [Node.js](https://nodejs.org/) (v18+) and [pnpm](https://pnpm.io/). ```bash -# Clone the repository git clone https://github.com/lycheeverse/lycheeverse.github.io.git -``` - -```bash -# Install dependencies +cd lycheeverse.github.io pnpm install -``` - -```bash -# Start local dev server pnpm dev ``` -## Contributing - -We welcome contributions! Here's how to help: +Other scripts: `pnpm build` (production build), `pnpm preview` (serve the build), `pnpm lint`, and `pnpm format`. -### Report Issues - -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). - -### Submit Changes +## Contributing -1. Fork the repository -2. Create a feature branch -3. Make your changes (fix typos, broken links, etc.) -4. Submit a pull request +Documentation lives in `src/content/` as Markdown/MDX. To contribute, fork the repo, make your changes on a branch, and open a pull request. For problems, [open an issue](https://github.com/lycheeverse/lycheeverse.github.io/issues/new/choose). ## Project Structure From 31c13fcb6e618708811b1786150ce592cff9c8ca Mon Sep 17 00:00:00 2001 From: Matthias Date: Thu, 11 Jun 2026 12:49:54 +0200 Subject: [PATCH 2/3] Document make watch and pnpm precommit in README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e750902..4e11d84 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,14 @@ pnpm install pnpm dev ``` -Other scripts: `pnpm build` (production build), `pnpm preview` (serve the build), `pnpm lint`, and `pnpm format`. +Other scripts: `pnpm build` (production build), `pnpm preview` (serve the build), `pnpm lint`, and `pnpm format`. You can also run `make watch` as a shortcut for `pnpm dev`. ## Contributing Documentation lives in `src/content/` as Markdown/MDX. To contribute, fork the repo, make your changes on a branch, and open a pull request. For problems, [open an issue](https://github.com/lycheeverse/lycheeverse.github.io/issues/new/choose). +Before opening a pull request, run `pnpm precommit` to check formatting and linting, since CI enforces both. + ## Project Structure ``` From 5cad617556bb035b0b705ca11f1097d0d9984024 Mon Sep 17 00:00:00 2001 From: Matthias Date: Thu, 11 Jun 2026 12:51:43 +0200 Subject: [PATCH 3/3] Remove outdated project structure section --- README.md | 23 +++++++++-------------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 4e11d84..f948411 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# lychee Documentation +# lychee docs -Source for the official documentation of [lychee](https://github.com/lycheeverse/lychee/), a fast, async link checker. +This is the source for the official documentation of [lychee](https://github.com/lycheeverse/lychee/), a fast, async link checker. [![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) [![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) @@ -19,20 +19,15 @@ pnpm install pnpm dev ``` -Other scripts: `pnpm build` (production build), `pnpm preview` (serve the build), `pnpm lint`, and `pnpm format`. You can also run `make watch` as a shortcut for `pnpm dev`. +Here are some helpful commands: + +- `pnpm build`: production build +- `pnpm preview`: serve the build +- `pnpm lint` and `pnpm format`: check and fix formatting and linting +- `make watch` or `pnpm dev`: watch for changes and rebuild ## Contributing Documentation lives in `src/content/` as Markdown/MDX. To contribute, fork the repo, make your changes on a branch, and open a pull request. For problems, [open an issue](https://github.com/lycheeverse/lycheeverse.github.io/issues/new/choose). -Before opening a pull request, run `pnpm precommit` to check formatting and linting, since CI enforces both. - -## Project Structure - -``` -├── src/ -│ ├── assets/ # Images and static files -│ └── content/ # Documentation pages (Markdown/MDX) -├── astro.config.mjs # Astro configuration -└── package.json -``` +Before opening a pull request, run `pnpm precommit` to check formatting and linting.