Define a naming style for prompt block titles
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 78/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- javascript
调研方向
从 standards/page-structure.md 中的“Prompt examples”部分开始，并按照建议的搜索命令 grep -rn 'prompt title=".* prompt"' sources 查找需要重命名的标题。添加所提议的标题样式规则，并更新匹配的标题；当指南已记录且现有标题遵循该规则时，工作即告完成。
由索引模型根据 Issue 内容生成。
描述
Prompt block titles (```prompt title="…") follow two styles:
- All 14 Academy titles end in "prompt", for example "Draft user README prompt", "Recommend pricing prompt", "Change input URL prompt" and "Log items prompt" (in
sources/academy/webscraping/scraping_with_ai/). apify/apify-docs#3164 adds 4 more. - Platform titles don't, for example "Find a Google Maps Actor" and "Run a saved task".
The card already has a Copy prompt button, so the suffix repeats what the card shows. The "Prompt examples" section in standards/page-structure.md, added in apify/apify-docs#3164, says to set a title but not how to write one.
Proposal:
- Add a rule to
standards/page-structure.md#prompt-examples, for example: "Write the title as a short imperative phrase in sentence case that says what the prompt does. Don't end it with 'prompt'." - Rename the existing titles that end in "prompt" (
grep -rn 'prompt title=".* prompt"' sources).
- 主要语言
- JavaScript
- 星标
- 82
- 派生
- 240
- 平均合并
- 3 天 10 小时
- 30 天内合并 PR
- 71
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
apify/apify-docs 的其他 Issue
-
bug documentation
难度 1/5 1-3 小时 新手友好度 88/100
apify/apify-docs#3206 ·
维护者通常 1 天内回复
-
Incorrect property in Step 5 of the “Find FIFA logo” exercise solution可能已有人在做 @honzajavorek 于 9 天前认领。 未关闭academy t-docs
难度 1/5 1 小时以内 新手友好度 85/100
apify/apify-docs#3049 · 1 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
apify/apify-docs#2742 ·
维护者通常 1 天内回复
-
docs(academy): teach explicit .input reference in actor.json; auto-discovery is deprecated可能已有人在做 @honzajavorek 于 4 天前认领。 未关闭
难度 1/5 1-3 小时 新手友好度 82/100
apify/apify-docs#2741 ·
维护者通常 1 天内回复
-
low priority t-unblocking tech enhancement
难度 2/5 1-3 小时 新手友好度 65/100
apify/apify-docs#2451 ·
维护者通常 1 天内回复
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 88/100
obsidianmd/obsidian-help#1169 ·
维护者通常 2 天内回复
-
[docs] RELEASE.md: wrong branch name, no check that the prepare PR merged with the right subject, manual publish step可能已有人在做 @albertteoh 今天认领。 未关闭documentation
难度 2/5 1-3 小时 新手友好度 85/100
jaegertracing/jaeger-ui#4739 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
-
documentation
难度 2/5 1-3 小时 新手友好度 74/100
keepassxreboot/keepassxc-browser#3159 · 1 条评论 ·
-
Add: ESP 2 RS未关闭approved check:passed feeds:add
难度 1/5 1 小时以内 新手友好度 67/100