Skip to content
Closed
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
616fe00
Refactor README intro for clarity and layout
RafaelJohn9 May 23, 2025
61b0883
Add detailed Table of Contents for project documentation
RafaelJohn9 May 23, 2025
6fad6bf
Add "Getting Started" section with recommended cloning method
RafaelJohn9 May 23, 2025
000aad3
Remove $ from shell commands to improve copy-pasting
RafaelJohn9 May 23, 2025
b167db0
Add manual sparse clone instructions and remove $ from commands
RafaelJohn9 May 23, 2025
0c06fa8
Refine note on using sparse-checkout with existing full clones
RafaelJohn9 May 23, 2025
5481388
Add detailed directory structure section with descriptions
RafaelJohn9 May 23, 2025
289edb6
Revamp local development section with prerequisites and serving instr…
RafaelJohn9 May 23, 2025
3461aa1
Clarify usage of Hugo’s built-in server with ugly URLs disabled
RafaelJohn9 May 23, 2025
283537a
Add "Enabling Search Locally" section and clean up shell command form…
RafaelJohn9 May 23, 2025
3f0cb77
Update Pagefind server instructions and add note on performance impact
RafaelJohn9 May 23, 2025
d9c5731
Revise Testing section for clarity and improved formatting
RafaelJohn9 May 23, 2025
aaf72d5
Clarify Playwright setup and testing instructions
RafaelJohn9 May 23, 2025
3adf702
Refactor manual pages section for clarity and structure
RafaelJohn9 May 23, 2025
bf34f05
Clarify manual page generation instructions and add localized build s…
RafaelJohn9 May 23, 2025
b33b0f8
Refactor instructions for downloads data and ProGit book updates
RafaelJohn9 May 23, 2025
ef25c49
Improve ProGit book update instructions
RafaelJohn9 May 23, 2025
b5f4412
Improve contribution instructions
RafaelJohn9 May 23, 2025
aee7190
Add detailed instructions for adding new GUI clients
RafaelJohn9 May 23, 2025
1311004
Refactor and enhance Useful Links section
RafaelJohn9 May 23, 2025
863f29f
Improve formatting and clarity of License section
RafaelJohn9 May 23, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,19 +122,17 @@ npx -y pagefind --site public --serve

---

Believe it or not, https://git-scm.com/ has its own test suite. It uses [Playwright](https://playwright.dev/) to perform a couple of tests that verify that the site "looks right". These tests live in `tests/` and are configured via `playwright.config.js`.
## Testing

To run these tests in your local setup, you need a working node.js installation. After that, you need to install Playwright:
The site includes a test suite using [Playwright](https://playwright.dev/) to verify UI correctness. Tests are located in the `tests/` directory and configured via `playwright.config.js`.

```console
$ npm install @playwright/test
```
### Running Tests

Since Playwright uses headless versions of popular web browsers, you most likely need to install at least one of them, e.g. via:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is another important piece of information that seems to be culled in the name of clarity. I do disagree that this is a good idea.

1. Install Playwright:

```console
$ npx playwright install firefox
```
```console
npm install @playwright/test
```

Supported browsers include `firefox`, `chromium`, `webkit`, `chrome`. You can also simply download all of them using `npx playwright install` but please first note that they all weigh >100MB, so you might want to refrain from doing that. Side note: In GitHub Actions' hosted runners, Chrome comes pre-installed, and you might be able to use your own Chrome installation, too, if you have one.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm. I'm not a fan of dropping this important information on the floor.


Expand Down