Skip to content

Commit 06152d8

Browse files
committed
docs: move localized docs into docs folder
- keep the English README at the repository root - move localized README files and screenshots into docs - update README and AGENTS references to the new docs paths
1 parent 86b7840 commit 06152d8

7 files changed

Lines changed: 29 additions & 20 deletions

File tree

AGENTS.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
- Other files in `assets/js/*.js` should keep a focused responsibility instead of moving unrelated logic back into `app.js`.
1818
- `assets/js/locales/*.js` contains UI translations; any user-facing copy change should be updated across all locales.
1919
- `README.md` is the primary English README.
20-
- `README.zh-TW.md` and `README.ja.md` are localized README files and should be updated alongside the English README when needed.
21-
- `demo.png`, `demo.zh-TW.png`, and `demo.ja.png` are localized screenshots and should be updated together when the UI changes in a way that affects the documentation images.
20+
- `docs/README.zh-TW.md` and `docs/README.ja.md` are localized README files and should be updated alongside the English README when needed.
21+
- `docs/demo.png`, `docs/demo.zh-TW.png`, and `docs/demo.ja.png` are localized screenshots and should be updated together when the UI changes in a way that affects the documentation images.
2222

2323
## General Working Rules
2424

@@ -67,12 +67,12 @@
6767
- English is the source language for project documentation.
6868
- When README content changes, review and update:
6969
- `README.md`
70-
- `README.zh-TW.md`
71-
- `README.ja.md`
70+
- `docs/README.zh-TW.md`
71+
- `docs/README.ja.md`
7272
- When screenshots become outdated due to UI changes, update:
73-
- `demo.png`
74-
- `demo.zh-TW.png`
75-
- `demo.ja.png`
73+
- `docs/demo.png`
74+
- `docs/demo.zh-TW.png`
75+
- `docs/demo.ja.png`
7676
- Localized README files and screenshots should stay meaningfully aligned with the English source.
7777

7878
## CSS / UI Style Guide

README.md

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

3-
[English](./README.md) | [繁體中文](./README.zh-TW.md) | [日本語](./README.ja.md)
3+
[English](./README.md) | [繁體中文](./docs/README.zh-TW.md) | [日本語](./docs/README.ja.md)
44

55
Replace sensitive details before sending text to an LLM.
66

@@ -16,7 +16,7 @@ If you want to test locally, serve this folder with any simple static server and
1616

1717
## Screenshot
1818

19-
![demo](./demo.png)
19+
![demo](./docs/demo.png)
2020

2121
## Features
2222

@@ -34,10 +34,13 @@ If you want to test locally, serve this folder with any simple static server and
3434
```text
3535
.
3636
├── index.html
37-
├── demo.png
3837
├── README.md
39-
├── README.zh-TW.md
40-
├── README.ja.md
38+
├── docs
39+
│ ├── README.zh-TW.md
40+
│ ├── README.ja.md
41+
│ ├── demo.png
42+
│ ├── demo.zh-TW.png
43+
│ └── demo.ja.png
4144
└── assets
4245
├── favicon.png
4346
├── css

README.ja.md renamed to docs/README.ja.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PrePrompt
22

3-
[English](./README.md) | [繁體中文](./README.zh-TW.md) | [日本語](./README.ja.md)
3+
[English](../README.md) | [繁體中文](./README.zh-TW.md) | [日本語](./README.ja.md)
44

55
LLM に文章を貼り付ける前に、PrePrompt で機密情報を置き換えます。
66

@@ -34,10 +34,13 @@ PrePrompt はブラウザで動く小さなツールです。単なる文字置
3434
```text
3535
.
3636
├── index.html
37-
├── demo.png
3837
├── README.md
39-
├── README.zh-TW.md
40-
├── README.ja.md
38+
├── docs
39+
│ ├── README.zh-TW.md
40+
│ ├── README.ja.md
41+
│ ├── demo.png
42+
│ ├── demo.zh-TW.png
43+
│ └── demo.ja.png
4144
└── assets
4245
├── favicon.png
4346
├── css

README.zh-TW.md renamed to docs/README.zh-TW.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PrePrompt
22

3-
[English](./README.md) | [繁體中文](./README.zh-TW.md) | [日本語](./README.ja.md)
3+
[English](../README.md) | [繁體中文](./README.zh-TW.md) | [日本語](./README.ja.md)
44

55
將文字貼進 LLM 前,用 PrePrompt 替換敏感資訊。
66

@@ -34,10 +34,13 @@ PrePrompt 是一個在瀏覽器中執行的小工具,重點不只是文字取
3434
```text
3535
.
3636
├── index.html
37-
├── demo.png
3837
├── README.md
39-
├── README.zh-TW.md
40-
├── README.ja.md
38+
├── docs
39+
│ ├── README.zh-TW.md
40+
│ ├── README.ja.md
41+
│ ├── demo.png
42+
│ ├── demo.zh-TW.png
43+
│ └── demo.ja.png
4144
└── assets
4245
├── favicon.png
4346
├── css
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)