Skip to content

Commit 88d6cca

Browse files
committed
docs: polish public maintenance docs
1 parent 710c327 commit 88d6cca

6 files changed

Lines changed: 32 additions & 23 deletions

File tree

README.en.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -450,4 +450,8 @@ Want to be on this list? Open an [issue](https://github.com/dwgx/WindsurfAPI/iss
450450

451451
## License
452452

453-
MIT
453+
MIT License. See [LICENSE](LICENSE).
454+
455+
## Star History
456+
457+
https://www.star-history.com/?type=date&repos=dwgx/WindsurfAPI

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,8 +453,12 @@ A: 不能。长 thinking / 长输出在约 236-243 秒断流,是 Windsurf prov
453453

454454
## 授权
455455

456-
MIT
456+
MIT License. See [LICENSE](LICENSE).
457457

458458
## Release and Secret Boundary
459459

460460
Release automation may publish Docker images and GitHub Releases. Keep tokens, API keys, cookies, and provider credentials out of issues, pull requests, logs, and committed config. If a report needs authentication details, share only redacted metadata and reproduction steps.
461+
462+
## Star History
463+
464+
https://www.star-history.com/?type=date&repos=dwgx/WindsurfAPI

docs/HANDOFF.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# WindsurfAPI Agent Handoff
1+
# WindsurfAPI Maintainer Status
22

33
Last updated: 2026-06-07.
44

5-
This is the first file to read after a context reset. It summarizes the current
6-
state, what is still open, what not to claim, and where the supporting docs
7-
live. Do not paste secrets, account credentials, API keys, or raw session tokens
8-
into this file.
5+
This is the first file to read before maintenance work. It summarizes the
6+
current state, what is still open, what not to claim, and where the supporting
7+
docs live. Do not paste secrets, account credentials, API keys, or raw session
8+
tokens into this file.
99

1010
## Current State
1111

1212
- Repository: `D:\Project\WindsurfAPI`
13-
- Local/remote branch state at handoff: `master` is clean and aligned with
13+
- Local/remote branch state at last status update: `master` is clean and aligned with
1414
`origin/master`.
15-
- Last verified repository baseline before this handoff update: `562f98c`
15+
- Last verified repository baseline before this status update: `562f98c`
1616
(`docs: update handoff for v2.0.144`). After pulling, use
1717
`git log -1 --oneline` for the newest commit.
1818
- Latest release tag: `v2.0.144` at `3945c51`
@@ -149,5 +149,5 @@ For docs-only changes:
149149
LS preflight refused with `ls_capacity:memory_guard`; that is not protocol
150150
evidence.
151151
- The current docs intentionally keep issue audit, maintainer rules, release
152-
notes, and protocol notes separate so the next agent can update the right
153-
layer without rewriting everything.
152+
notes, and protocol notes separate so maintainers can update the right layer
153+
without rewriting everything.

docs/PROTOCOL_RE_PLAN.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
Status: planning artifact (2026-06-10). Goal: make WindsurfAPI's reverse-engineered
44
Cascade protocol layer complete/correct ("protocol perfect"), at cliproxyapi-class
5-
quality. Execute the heavy steps via Codex when its backend recovers (it was returning
6-
`503` from `v-api.hk.yesfuture.ai` at planning time). Claude orchestrates + verifies on
7-
the lab box; do not burn Claude tokens on bulk reads/traces that Codex can do.
5+
quality. Execute heavy inventory, trace analysis, and test work in the lab workflow
6+
when backend access is available; one backend was returning `503` from
7+
`v-api.hk.yesfuture.ai` at planning time. Keep credentials out of prompts, logs, and
8+
repo files.
89

910
## Lab box runbook (the RE asset)
1011

@@ -76,15 +77,15 @@ Missing vs cliproxyapi-class:
7677
- OpenAI `/v1/embeddings` (only if Cascade exposes embeddings — verify first).
7778
- OpenAI legacy `/v1/completions` (minor).
7879

79-
## Codex delegation queue (run when 503 clears)
80+
## Implementation work queue (run when backend access is healthy)
8081
- A: external benchmark — cliproxyapi (router-for-me/CLIProxyAPI) + kiro.rs feature/protocol
8182
matrix (retry the task that 503'd).
8283
- B: internal protocol-RE inventory (retry the task that 503'd) — confirmed vs stub map.
8384
- C: implement endpoint(s) from item 5 (start with count_tokens) with tests.
84-
- D: given lab-box traces Claude supplies, update windsurf.js/proto-trace.js parsers + tests
85+
- D: given lab-box traces, update windsurf.js/proto-trace.js parsers + tests
8586
per items 1–4.
86-
Pattern: Codex does bulk reads/writes/tests; Claude supplies trace evidence from the lab box
87-
and verifies results. Keep credentials out of Codex prompts/logs.
87+
Pattern: use bulk automation for reads, writes, and tests; use lab-box trace evidence
88+
for parser changes and verification. Keep credentials out of prompts and logs.
8889

8990
## Verification + release rules (unchanged)
9091
Per [docs/MAINTAINER_NOTES.md]: focused tests + `npm run test:release` + `npm run secret-scan`,

docs/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22

33
## Start Here
44

5-
- [Agent Handoff](HANDOFF.md): current state, open issues, next priority order,
6-
VPS entrypoint notes, and hard boundaries for the next agent after a context
7-
reset.
5+
- [Maintainer Status](HANDOFF.md): current state, open issues, next priority
6+
order, VPS entrypoint notes, and hard boundaries for maintenance work.
87
- [Maintainer Notes](MAINTAINER_NOTES.md): persistent quality, release,
98
security, native bridge, SWE, WebFetch, code, and UI working rules.
109

@@ -27,10 +26,10 @@
2726
## Release History
2827

2928
- [Release notes index](releases/): release-specific changes.
30-
- Release notes are append-only history. Put current handoff or roadmap changes
29+
- Release notes are append-only history. Put current status or roadmap changes
3130
in `HANDOFF.md` / `audits/`, not in old release notes.
3231

3332
## Generated Site
3433

3534
- [index.html](index.html): GitHub Pages/static docs output. Do not use it as
36-
the canonical place for operational handoff.
35+
the canonical place for operational status.

docs/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -904,6 +904,7 @@ <h2 class="section-title">這些朋友把這個專案<em>撐起來</em>了。</h
904904
<h5>專案</h5>
905905
<ul>
906906
<li><a href="https://github.com/dwgx/WindsurfAPI" target="_blank" rel="noopener">GitHub</a></li>
907+
<li><a href="https://www.star-history.com/?type=date&repos=dwgx/WindsurfAPI" target="_blank" rel="noopener">Star History</a></li>
907908
<li><a href="https://github.com/dwgx/WindsurfAPI/releases" target="_blank" rel="noopener">Releases</a></li>
908909
<li><a href="https://github.com/dwgx/WindsurfAPI/issues" target="_blank" rel="noopener">Issues</a></li>
909910
<li><a href="https://github.com/dwgx/WindsurfAPI/blob/master/SECURITY.md" target="_blank" rel="noopener">Security</a></li>

0 commit comments

Comments
 (0)