[PR #569] [MERGED] feat: update docs #631

Closed
opened 2026-02-26 21:32:08 +03:00 by kerem · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569
Author: @dreamhunter2333
Created: 1/22/2025
Status: Merged
Merged: 1/22/2025
Merged by: @dreamhunter2333

Base: mainHead: feature/dev


📝 Commits (1)

📊 Changes

21 files changed (+608 additions, -541 deletions)

View changed files

📝 README.md (+2 -2)
📝 frontend/package.json (+3 -3)
📝 frontend/pnpm-lock.yaml (+94 -94)
📝 pages/package.json (+1 -1)
📝 vitepress-docs/docs/.vitepress/zh.ts (+8 -3)
📝 vitepress-docs/docs/en/cli.md (+2 -2)
vitepress-docs/docs/zh/guide/actions/auto-update.md (+10 -0)
vitepress-docs/docs/zh/guide/actions/d1.md (+3 -0)
📝 vitepress-docs/docs/zh/guide/actions/github-action.md (+2 -5)
📝 vitepress-docs/docs/zh/guide/cli/worker.md (+11 -82)
📝 vitepress-docs/docs/zh/guide/quick-start.md (+14 -7)
📝 vitepress-docs/docs/zh/guide/ui/worker.md (+9 -1)
vitepress-docs/docs/zh/guide/worker-vars.md (+126 -0)
📝 vitepress-docs/package.json (+2 -2)
📝 vitepress-docs/pnpm-lock.yaml (+227 -245)
📝 worker/package.json (+5 -5)
📝 worker/pnpm-lock.yaml (+80 -80)
📝 worker/src/admin_api/worker_config.ts (+1 -1)
📝 worker/src/commom_api.ts (+1 -1)
📝 worker/src/common.ts (+2 -2)

...and 1 more files

📄 Description

PR Type

Documentation, Enhancement


Description

  • Updated documentation for worker variables and configurations.

  • Enhanced API to use getStringValue for PREFIX.

  • Updated dependencies in pnpm-lock.yaml and package.json.

  • Added new documentation files for auto-update and D1 database.


Changes walkthrough 📝

Relevant files
Documentation
3 files
zh.ts
Updated sidebar structure and links                                           
+8/-3     
worker-vars.md
Added documentation for worker variables                                 
+126/-0 
worker.md
Updated CLI documentation with worker variable reference 
+11/-82 
Enhancement
3 files
commom_api.ts
Use `getStringValue` for `PREFIX`                                               
+1/-1     
common.ts
Use `getStringValue` for `PREFIX`                                               
+2/-2     
worker_config.ts
Use `getStringValue` for `PREFIX`                                               
+1/-1     
Dependencies
3 files
pnpm-lock.yaml
Updated dependencies                                                                         
+227/-245
pnpm-lock.yaml
Updated dependencies                                                                         
+94/-94 
package.json
Updated dependencies                                                                         
+3/-3     
Additional files
12 files
README.md +2/-2     
package.json +1/-1     
cli.md +2/-2     
auto-update.md +10/-0   
d1.md +3/-0     
github-action.md +2/-5     
quick-start.md +14/-7   
worker.md +9/-1     
package.json +2/-2     
package.json +5/-5     
pnpm-lock.yaml +80/-80 
wrangler.toml.template +5/-5     

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569 **Author:** [@dreamhunter2333](https://github.com/dreamhunter2333) **Created:** 1/22/2025 **Status:** ✅ Merged **Merged:** 1/22/2025 **Merged by:** [@dreamhunter2333](https://github.com/dreamhunter2333) **Base:** `main` ← **Head:** `feature/dev` --- ### 📝 Commits (1) - [`47e2e41`](https://github.com/dreamhunter2333/cloudflare_temp_email/commit/47e2e41ec6f1e091bf1cd8c201b41c0bf7fbdb45) feat: update docs ### 📊 Changes **21 files changed** (+608 additions, -541 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+2 -2) 📝 `frontend/package.json` (+3 -3) 📝 `frontend/pnpm-lock.yaml` (+94 -94) 📝 `pages/package.json` (+1 -1) 📝 `vitepress-docs/docs/.vitepress/zh.ts` (+8 -3) 📝 `vitepress-docs/docs/en/cli.md` (+2 -2) ➕ `vitepress-docs/docs/zh/guide/actions/auto-update.md` (+10 -0) ➕ `vitepress-docs/docs/zh/guide/actions/d1.md` (+3 -0) 📝 `vitepress-docs/docs/zh/guide/actions/github-action.md` (+2 -5) 📝 `vitepress-docs/docs/zh/guide/cli/worker.md` (+11 -82) 📝 `vitepress-docs/docs/zh/guide/quick-start.md` (+14 -7) 📝 `vitepress-docs/docs/zh/guide/ui/worker.md` (+9 -1) ➕ `vitepress-docs/docs/zh/guide/worker-vars.md` (+126 -0) 📝 `vitepress-docs/package.json` (+2 -2) 📝 `vitepress-docs/pnpm-lock.yaml` (+227 -245) 📝 `worker/package.json` (+5 -5) 📝 `worker/pnpm-lock.yaml` (+80 -80) 📝 `worker/src/admin_api/worker_config.ts` (+1 -1) 📝 `worker/src/commom_api.ts` (+1 -1) 📝 `worker/src/common.ts` (+2 -2) _...and 1 more files_ </details> ### 📄 Description ### **PR Type** Documentation, Enhancement ___ ### **Description** - Updated documentation for worker variables and configurations. - Enhanced API to use `getStringValue` for `PREFIX`. - Updated dependencies in `pnpm-lock.yaml` and `package.json`. - Added new documentation files for auto-update and D1 database. ___ ### **Changes walkthrough** 📝 <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><details><summary>3 files</summary><table> <tr> <td><strong>zh.ts</strong><dd><code>Updated sidebar structure and links</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-9d8e658367b9c916dfc920a8c02a2b3c62478f36302f223b97707919e42308a0">+8/-3</a>&nbsp; &nbsp; &nbsp; </td> </tr> <tr> <td><strong>worker-vars.md</strong><dd><code>Added documentation for worker variables</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-1bd83b534dfb9159de9157e0943a1f5191373ecdb5af08552c8033464596d223">+126/-0</a>&nbsp; </td> </tr> <tr> <td><strong>worker.md</strong><dd><code>Updated CLI documentation with worker variable reference</code>&nbsp; </dd></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-f760a2ec5dad4b6bda0bd4a9325274567778add8cb984e73650dbaaf680c9178">+11/-82</a>&nbsp; </td> </tr> </table></details></td></tr><tr><td><strong>Enhancement</strong></td><td><details><summary>3 files</summary><table> <tr> <td><strong>commom_api.ts</strong><dd><code>Use `getStringValue` for `PREFIX`</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-fe2dec25bee7d722fe8aa25b616c21bd12b8123e26469f5cac11c9164be783c3">+1/-1</a>&nbsp; &nbsp; &nbsp; </td> </tr> <tr> <td><strong>common.ts</strong><dd><code>Use `getStringValue` for `PREFIX`</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-fcc08fd5aa3c190d0d45c7e3dd208e5ee831d360b272fdd5869607cf472c5eb1">+2/-2</a>&nbsp; &nbsp; &nbsp; </td> </tr> <tr> <td><strong>worker_config.ts</strong><dd><code>Use `getStringValue` for `PREFIX`</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-49df0a54d190cb8ea3788432fae88000683da8e61a5c4d0d184c8b7f0015a0ae">+1/-1</a>&nbsp; &nbsp; &nbsp; </td> </tr> </table></details></td></tr><tr><td><strong>Dependencies</strong></td><td><details><summary>3 files</summary><table> <tr> <td><strong>pnpm-lock.yaml</strong><dd><code>Updated dependencies</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-655c1410f6eacceaa9003212a9f840a660ace35e32e60d792be3640ec774af6f">+227/-245</a></td> </tr> <tr> <td><strong>pnpm-lock.yaml</strong><dd><code>Updated dependencies</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-41b1ff3a74ba81fa74c8dd225d66d81573be3f2990e1d98b9b09798b147d40a8">+94/-94</a>&nbsp; </td> </tr> <tr> <td><strong>package.json</strong><dd><code>Updated dependencies</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-da6498268e99511d9ba0df3c13e439d10556a812881c9d03955b2ef7c6c1c655">+3/-3</a>&nbsp; &nbsp; &nbsp; </td> </tr> </table></details></td></tr><tr><td><strong>Additional files</strong></td><td><details><summary>12 files</summary><table> <tr> <td><strong>README.md</strong></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5">+2/-2</a>&nbsp; &nbsp; &nbsp; </td> </tr> <tr> <td><strong>package.json</strong></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-74314f72f6616d400be4cb0d161867d8148f23c22d4c12c7188aedb129c00c59">+1/-1</a>&nbsp; &nbsp; &nbsp; </td> </tr> <tr> <td><strong>cli.md</strong></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-3f8f72a691fa19c8581621e91cf67ad28855af7a57e58513f6563cf4c8886e5f">+2/-2</a>&nbsp; &nbsp; &nbsp; </td> </tr> <tr> <td><strong>auto-update.md</strong></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-734e5af6209ad8ae4342c0b2b9cb1be7589170b23a2bef344652b26ac42e4018">+10/-0</a>&nbsp; &nbsp; </td> </tr> <tr> <td><strong>d1.md</strong></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-2bac285c3d922850a0aed820179fc4446251bf54673863803a2e632d5210d050">+3/-0</a>&nbsp; &nbsp; &nbsp; </td> </tr> <tr> <td><strong>github-action.md</strong></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-20e3a87261fbf349a334ecb320c5c40bab4755ba22de17d84604b741d8ffeb23">+2/-5</a>&nbsp; &nbsp; &nbsp; </td> </tr> <tr> <td><strong>quick-start.md</strong></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-f531686509cdb2aab070cd8a2574e350c1a6f4ef36242ea9e463e344cdc51af0">+14/-7</a>&nbsp; &nbsp; </td> </tr> <tr> <td><strong>worker.md</strong></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-ed132f8c7a4d0a1bd98a708c0577a087c30833499ef59c1f30f1b819a351290d">+9/-1</a>&nbsp; &nbsp; &nbsp; </td> </tr> <tr> <td><strong>package.json</strong></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-3adbfbfaa65ecc60f48c8d009a52c697d4c80d61ee887799df22407fcb73f380">+2/-2</a>&nbsp; &nbsp; &nbsp; </td> </tr> <tr> <td><strong>package.json</strong></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-89dc6f41a53ce13f2da5a00dd34868762e6cd0df46eddc9f5c3c4510b1493870">+5/-5</a>&nbsp; &nbsp; &nbsp; </td> </tr> <tr> <td><strong>pnpm-lock.yaml</strong></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-b40cf923090a5fb5f6cc0d6ce716c560645419d762871abb50383fdb423288c6">+80/-80</a>&nbsp; </td> </tr> <tr> <td><strong>wrangler.toml.template</strong></td> <td><a href="https://github.com/dreamhunter2333/cloudflare_temp_email/pull/569/files#diff-743273da72481b71fbeb1dddfd294be9249554eef65691dfc9bcfa9f0fd971fb">+5/-5</a>&nbsp; &nbsp; &nbsp; </td> </tr> </table></details></td></tr></tr></tbody></table> ___ > 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull request to receive relevant information --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-02-26 21:32:08 +03:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/cloudflare_temp_email#631
No description provided.