PowerShell / PowerShell/PowerShellEditorServices

No user documentation?

未關閉
#968 6 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

Area-Documentation Issue-Enhancement
主要語言
C#
星號
767
分支
266
平均合併
3 天 16 小時
30 天內合併 PR
1

描述

The Short

Could not figure out how to run in STDIO mode. Could find no up-to-date documentation.

The Long

After discovering that this project has a general STDIO LSP mode, I wasted time between the:

  1. README (that has been saying "detailed usage documentation...coming soon!" since 2017)
  2. Docs (that haven't changed since 2016)
  3. Issue comments

before eventually figuring it out by referring to COC's code.

I still have no idea what possible -AdditionalModules or -FeatureFlags exist, or whether I've even configured PSES correctly.

I would really appreciate some up-to-date documentation!

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

首先,將 issue 指出的已過時 README 和 Docs 與所參照的 COC PowerShell 程式碼進行比較。確認目前的 STDIO 設定,並記錄可用的 AdditionalModules 和 FeatureFlags。當使用者能夠根據最新的專案文件設定 PSES 並執行 STDIO 模式時,即表示完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
powershell
領域
documentation
Issue 類型
文件
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
需要釐清
新手友好度
25/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。