Docs generator for downstream CLI tools
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 30/100
- Issue 類型
- 功能
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- shell, typescript
- 領域
- cli, documentation
研究方向
先閱讀連結的 Cobra shell-completion 文件，並檢查 tab 現有文件網站的進入點。由於 issue 中沒有指定檔案或測試，因此首先確定由查詢參數驅動的文件頁面應該放在哪裡。完成的標準是：頁面能夠根據 CLI 工具名稱呈現自訂的 shell-completion 使用說明。
由索引模型根據 Issue 內容生成。
描述
To learn more about the best way to enable completions in each shell, I read the Cobra docs: https://cobra.dev/docs/how-to-guides/shell-completion/
It has general guidance, plus shell-specific details.
If I was writing my own CLI tool, and I wanted to provide documentation for my end-users to enable completions in their shell, I might copy-paste Cobra's page and rename ./your-cli to my tool's name. What if tab could generate those docs for me?
This can even be a page on tab's documentation website which CLI authors can link to. It can read URL query parameters to customize the documentation, for example: https://bomb.sh/docs/tab/how-to-install-completions?toolname=myfancycli
This page will render documentation, identical to cobra's page, customized for myfancycli. In the README for myfancycli, I can link to this page:
To enable completions, run myfancycli completion . For more detailed instructions see https://bomb.sh/docs/tab/how-to-install-completions?toolname=myfancycli
- 主要語言
- TypeScript
- 星號
- 282
- 分支
- 11
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
這個專案沒有提供開發容器、Dockerfile 或貢獻指南，環境需要你自己搭建：先看它的 README，通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
bombshell-dev/tab 的其他 Issue
-
An option is resolved from the root before the matched command, so a short name means one thing for the whole line可能已有人在做 @AmirSa12 於 26 天前認領。 未關閉
難度 4/5 3-5 天 新手友好度 56/100
bombshell-dev/tab#153 · 6 則留言 ·
-
enhancement
難度 3/5 1-2 天 新手友好度 55/100
bombshell-dev/tab#127 · 2 則留言 ·
-
難度 3/5 1-2 天 新手友好度 55/100
bombshell-dev/tab#118 ·
-
provide installation utilities可能已有人在做 @theoephraim 於 155 天前認領。 未關閉
難度 5/5 一週以上 新手友好度 35/100
bombshell-dev/tab#117 ·
-
難度 4/5 3-5 天 新手友好度 48/100
bombshell-dev/tab#107 · 3 則留言 ·
查看 bombshell-dev/tab 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 76/100
Northeastern-Electric-Racing/FinishLine#4660 ·
維護者通常 2 天內回覆
-
難度 2/5 1-3 小時 新手友好度 86/100
excaliburjs/Excalibur#3895 ·
維護者通常 3 天內回覆
-
infer_audio_type only recognises one MPEG Layer III frame header, so most MP3 files are rejected可能已有人在做 @Steve-20-ai 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 78/100
維護者通常 1 天內回覆
-
Earn report crashes with "RangeError: Invalid time value" when a report row has an unparsable timestamp可能已有人在做 @Gurkaran18 今天認領。 未關閉bug
難度 2/5 1-3 小時 新手友好度 75/100
joinmarket-webui/jam#1588 ·
維護者通常 3 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
mihaip/infinite-mac#475 ·