Skip to content

Commit dfbc77d

Browse files
CopilotNewFutureCopilot
authored
docs: sync llms.txt with CloudNS and automate doc changes detection (#666)
* Initial plan * docs(agents): update AGENTS.md with CloudNS files and version Co-authored-by: NewFuture <6290356+NewFuture@users.noreply.github.com> * docs(agents): remove unnecessary emphasis on test_provider_cloudns.py Co-authored-by: NewFuture <6290356+NewFuture@users.noreply.github.com> * docs: update llms.txt with CloudNS and enhance update-agents workflow Co-authored-by: NewFuture <6290356+NewFuture@users.noreply.github.com> * Update .github/scripts/update_agents_structure.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix: remove trailing whitespace in update_agents_structure.py Co-authored-by: NewFuture <6290356+NewFuture@users.noreply.github.com> * fix: update script to use 'docs/' instead of 'doc/' directory Co-authored-by: NewFuture <6290356+NewFuture@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: NewFuture <6290356+NewFuture@users.noreply.github.com> Co-authored-by: New Future <NewFuture@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent f26d506 commit dfbc77d

3 files changed

Lines changed: 14 additions & 5 deletions

File tree

.github/scripts/update_agents_structure.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,20 +55,23 @@ def parse_agents_md():
5555
stack.append(name.rstrip("/"))
5656
else:
5757
path = "/".join(stack + [name])
58-
if path.startswith(("ddns/", "doc/", "schema/")) and not path.endswith((".png", ".svg", ".jpg", ".gif", ".ico")):
58+
if path.startswith(("ddns/", "docs/", "schema/")) and not path.endswith((".png", ".svg", ".jpg", ".gif", ".ico")):
5959
files.add(path)
6060
return files
6161

6262

6363
def main():
6464
# type: () -> None
6565
actual = (
66-
scan_files("ddns", (".py")) | scan_files("doc", (".md",)) | scan_files("schema", (".json",))
66+
scan_files("ddns", (".py")) | scan_files("docs", (".md",)) | scan_files("schema", (".json",))
6767
)
6868
documented = parse_agents_md()
6969

7070
added, deleted = sorted(actual - documented), sorted(documented - actual)
7171

72+
# Check if any changes are in docs/ directory
73+
docs_changes = any(f.startswith("docs/") for f in added + deleted)
74+
7275
# Remove old issue body file if exists
7376
if os.path.exists(ISSUE_BODY_FILE):
7477
os.remove(ISSUE_BODY_FILE)
@@ -88,6 +91,8 @@ def main():
8891
lines.extend("- `%s`" % f for f in deleted)
8992
lines.append("")
9093
lines.append("## Required Updates\n1. Update directory structure\n2. Update version/date")
94+
if docs_changes:
95+
lines.append("3. Update docs/llms.txt")
9196
lines.append("\n---\n*Auto-generated by update-agents workflow.*")
9297

9398
with open(ISSUE_BODY_FILE, "w", encoding="utf-8") as f:

AGENTS.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ ddns/: Main application code
7979
aliesa.py: Alibaba Cloud ESA
8080
callback.py: Custom webhook callbacks
8181
cloudflare.py: Cloudflare DNS
82+
cloudns.py: ClouDNS
8283
debug.py: Debug provider
8384
dnscom.py: DNS.COM
8485
dnspod.py: DNSPod (China)
@@ -138,6 +139,7 @@ docs/: Documentation (VitePress-based)
138139
aliesa.md: Alibaba Cloud ESA guide
139140
callback.md: Custom webhook callbacks guide
140141
cloudflare.md: Cloudflare DNS guide
142+
cloudns.md: ClouDNS guide
141143
debug.md: Debug provider guide
142144
dnscom.md: DNS.COM provider guide
143145
dnspod.md: DNSPod (China) guide
@@ -165,6 +167,7 @@ docs/: Documentation (VitePress-based)
165167
aliesa.md: Alibaba Cloud ESA guide
166168
callback.md: Custom webhook callbacks guide
167169
cloudflare.md: Cloudflare DNS guide
170+
cloudns.md: ClouDNS guide
168171
debug.md: Debug provider guide
169172
dnscom.md: DNS.COM provider guide
170173
dnspod.md: DNSPod (China) guide
@@ -580,6 +583,6 @@ For detailed information on specific topics, refer to:
580583

581584
---
582585

583-
**Version**: 1.0.3
584-
**Last Updated**: 2026-01-13
586+
**Version**: 1.0.4
587+
**Last Updated**: 2026-01-28
585588
**Maintained by**: DDNS Project Contributors

docs/llms.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ DDNS is a Python-based dynamic DNS client that automatically updates DNS records
3939
- Provider Overview: https://ddns.newfuture.cc/providers/
4040
- DNSPod: https://ddns.newfuture.cc/providers/dnspod
4141
- Cloudflare: https://ddns.newfuture.cc/providers/cloudflare
42+
- ClouDNS: https://ddns.newfuture.cc/providers/cloudns
4243
- AliDNS (Alibaba): https://ddns.newfuture.cc/providers/alidns
4344
- Tencent Cloud: https://ddns.newfuture.cc/providers/tecentcloud
4445
- Huawei Cloud: https://ddns.newfuture.cc/providers/huaweicloud
@@ -70,7 +71,7 @@ ddns --dns dnspod --id your_id --token your_token
7071

7172
## Supported DNS Providers
7273

73-
DNSPod, Cloudflare, AliDNS (Alibaba Cloud), Tencent Cloud, Huawei Cloud, GoDaddy, Namecheap, CloudXNS, HE.net, DynDNS, NoIP, 51Dns, Aliesa, Callback, and more.
74+
DNSPod, Cloudflare, ClouDNS, AliDNS (Alibaba Cloud), Tencent Cloud, Huawei Cloud, GoDaddy, Namecheap, CloudXNS, HE.net, DynDNS, NoIP, 51Dns, Aliesa, Callback, and more.
7475

7576
## Technical Details
7677

0 commit comments

Comments
 (0)