plugins/doc
2
0
Fork 0
Code Pull Requests Activity

docs(doc-funcs): 調整 README 方法目錄格式 #9

Merged
admin merged 2 commits from develop into master 2026-06-20 15:52:41 +00:00
Conversation 1 Commits 2 Files Changed 1
+1 -1
jiantw83 commented 2026-06-20 15:48:18 +00:00
Member
Copy Link
Copy Source

變更摘要

  • 調整 doc-funcs 產生 README 功能目錄的格式，每個公開方法固定佔兩行。
  • 第一行呈現功能描述，第二行呈現功能名稱與使用範例。
  • 功能名稱需盡量做成 Markdown 連結，導向 Gitea 上對應檔案的 function 起始行；無法可靠解析遠端 URL、分支或行號時才退回純文字。
  • README 功能目錄不再要求列出內部呼叫方法。

影響範圍

  • 影響 skills/doc-funcs/SKILL.md 的 README 功能目錄產出規格。
  • 不變更 runtime 程式碼或 plugin manifest。

風險與注意事項

  • 後續執行 doc-funcs 時，需要解析遠端 repo、分支與方法起始行才能產生最佳連結；解析失敗時規格允許退回純文字功能名稱。
## 變更摘要 - 調整 `doc-funcs` 產生 README 功能目錄的格式，每個公開方法固定佔兩行。 - 第一行呈現功能描述，第二行呈現功能名稱與使用範例。 - 功能名稱需盡量做成 Markdown 連結，導向 Gitea 上對應檔案的 function 起始行；無法可靠解析遠端 URL、分支或行號時才退回純文字。 - README 功能目錄不再要求列出內部呼叫方法。 ## 影響範圍 - 影響 `skills/doc-funcs/SKILL.md` 的 README 功能目錄產出規格。 - 不變更 runtime 程式碼或 plugin manifest。 ## 風險與注意事項 - 後續執行 `doc-funcs` 時，需要解析遠端 repo、分支與方法起始行才能產生最佳連結；解析失敗時規格允許退回純文字功能名稱。
jiantw83 added 2 commits 2026-06-20 15:48:18 +00:00
docs(doc-funcs): 調整 README 方法目錄格式 b0522c2b17
docs(doc-funcs): 連結 README 功能名稱到原始碼 6ed770dfde
admin approved these changes 2026-06-20 15:52:38 +00:00
admin merged commit 1ef41e2aff into master 2026-06-20 15:52:41 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
admin
Labels
No items
No labels
Milestone
No items
No Milestone
Assignees
Clear assignees
admin (系統管理員) jiantw83 (Jeffery)
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: plugins/doc#9