fix: format URLs in documentation for consistency
This commit is contained in:
1 parent
ce1021a44b
commit
875d9aeb7b
7 files changed
+17
-17
No files matched your search
@@ -16,7 +16,7 @@ Install JS dependencies once with `bun install --frozen-lockfile`.
|
||||
- `bun run format` / `bun run format:check`: run Prettier plus Go formatting checks.
|
||||
- `go test ./... -coverprofile=coverage.out -covermode=atomic` from `apps/api`: run API tests the same way CI does.
|
||||
- `go run ./cmd/api` from `apps/api`: run the API locally.
|
||||
- `docker compose -f docker-compose.yml -f docker-compose.build.yml up -d --build`: boot the full stack on `http://localhost:8080`.
|
||||
- `docker compose -f docker-compose.yml -f docker-compose.build.yml up -d --build`: boot the full stack on <http://localhost:8080>.
|
||||
|
||||
## Coding Style & Naming Conventions
|
||||
|
||||
|
||||
+1
-1
@@ -103,7 +103,7 @@ of classes of individuals.
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
|
||||
version 2.1, available at
|
||||
[https://www.contributor-covenant.org/version/2/1/code_of_conduct/](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
|
||||
<https://www.contributor-covenant.org/version/2/1/code_of_conduct/>.
|
||||
|
||||
Community Impact Guidelines were inspired by
|
||||
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
|
||||
+5
-5
@@ -25,15 +25,15 @@ usability win.
|
||||
|
||||
## Before you start
|
||||
|
||||
- Read [README.md](README.md) for the current project status and local setup.
|
||||
- Follow [MESSAGING.md](MESSAGING.md) when you touch README copy, homepage copy, SEO text, or
|
||||
- Read [`README.md`](README.md) for the current project status and local setup.
|
||||
- Follow [`MESSAGING.md`](MESSAGING.md) when you touch README copy, homepage copy, SEO text, or
|
||||
other product-facing messaging.
|
||||
- Search existing issues and pull requests before opening a new one.
|
||||
- For substantial features, architecture changes, or API contract changes, open an issue first.
|
||||
- For vulnerabilities or sensitive security concerns, follow [SECURITY.md](SECURITY.md) instead of
|
||||
- For vulnerabilities or sensitive security concerns, follow [`SECURITY.md`](SECURITY.md) instead of
|
||||
filing a public issue.
|
||||
- Keep general questions and troubleshooting in public channels when possible. See
|
||||
[SUPPORT.md](SUPPORT.md).
|
||||
[`SUPPORT.md`](SUPPORT.md).
|
||||
|
||||
## Development setup
|
||||
|
||||
@@ -59,7 +59,7 @@ defaults.
|
||||
docker compose -f docker-compose.yml -f docker-compose.build.yml up -d --build
|
||||
```
|
||||
|
||||
This brings up Xdrop, Postgres, Redis, and MinIO at `http://localhost:8080`.
|
||||
This brings up Xdrop, Postgres, Redis, and MinIO at <http://localhost:8080>.
|
||||
|
||||
### Run the frontend only
|
||||
|
||||
|
||||
@@ -366,11 +366,11 @@ From the repo root in a second terminal:
|
||||
bun run dev:web
|
||||
```
|
||||
|
||||
Open [http://localhost:5173](http://localhost:5173). During local development, the Vite dev
|
||||
Open <http://localhost:5173>. During local development, the Vite dev
|
||||
server proxies:
|
||||
|
||||
- `/api` to `http://localhost:8080`
|
||||
- `/xdrop` to `http://localhost:9000`
|
||||
- `/api` to <http://localhost:8080>
|
||||
- `/xdrop` to <http://localhost:9000>
|
||||
|
||||
This keeps frontend hot reload while talking to the local Go API and MinIO.
|
||||
|
||||
@@ -394,7 +394,7 @@ Install Playwright browsers once if needed:
|
||||
bun run test:e2e:install
|
||||
```
|
||||
|
||||
The E2E suite expects Xdrop at `http://localhost:8080` by default and uses the local `postgres`
|
||||
The E2E suite expects Xdrop at <http://localhost:8080> by default and uses the local `postgres`
|
||||
and `redis` Compose services during the tests. Start the full stack first:
|
||||
|
||||
```bash
|
||||
|
||||
+4
-4
@@ -326,10 +326,10 @@ go run ./cmd/api
|
||||
bun run dev:web
|
||||
```
|
||||
|
||||
打开 [http://localhost:5173](http://localhost:5173)。本地开发时,Vite 开发服务器会代理:
|
||||
打开 <http://localhost:5173>。本地开发时,Vite 开发服务器会代理:
|
||||
|
||||
- `/api` 到 `http://localhost:8080`
|
||||
- `/xdrop` 到 `http://localhost:9000`
|
||||
- `/api` 到 <http://localhost:8080>
|
||||
- `/xdrop` 到 <http://localhost:9000>
|
||||
|
||||
这样既能保留前端热更新,也能连接本地 Go API 和 MinIO。
|
||||
|
||||
@@ -353,7 +353,7 @@ bun run build:web
|
||||
bun run test:e2e:install
|
||||
```
|
||||
|
||||
E2E 套件默认会访问 `http://localhost:8080` 上的 Xdrop,并在测试期间使用本地 Compose 启动的 `postgres` 和 `redis` 服务。请先启动完整栈:
|
||||
E2E 套件默认会访问 <http://localhost:8080> 上的 Xdrop,并在测试期间使用本地 Compose 启动的 `postgres` 和 `redis` 服务。请先启动完整栈:
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose.yml -f docker-compose.build.yml up -d --build
|
||||
|
||||
+1
-1
@@ -34,4 +34,4 @@ Xdrop is a file transfer system with browser-side encryption. Security-sensitive
|
||||
- share-link lifecycle, expiry, and delete controls
|
||||
- secrets, environment configuration, and deployment defaults
|
||||
|
||||
Operational or configuration questions that are not vulnerabilities belong in [SUPPORT.md](SUPPORT.md).
|
||||
Operational or configuration questions that are not vulnerabilities belong in [`SUPPORT.md`](SUPPORT.md).
|
||||
+1
-1
@@ -43,7 +43,7 @@ Please share enough context for someone else to help:
|
||||
Do not file public issues for vulnerabilities, exposed secrets, or anything that could put users at
|
||||
risk.
|
||||
|
||||
Follow [SECURITY.md](SECURITY.md) and email [i@xi-xu.me](mailto:i@xi-xu.me) instead.
|
||||
Follow [`SECURITY.md`](SECURITY.md) and email [i@xi-xu.me](mailto:i@xi-xu.me) instead.
|
||||
|
||||
## Before you open an issue
|
||||
|
||||
|
||||
Reference in new issue
Block a user