README.mdを刷新(Ver0.0.7) - Githubissues

yasuraok / SimpleTextRefine

VSCode Extension for fast writing document using LLM

https://marketplace.visualstudio.com/items?itemName=yasuraok.simple-text-refine

MIT License

2 stars 1 forks source link

README.mdを刷新(Ver0.0.7) #5

Closed shimajima-eiji closed 5 months ago

shimajima-eiji commented 6 months ago

4

変更点

READMEの本文にver0.0.7の設定を追記しました
使い方を刷新しました。VSCode使ってるユーザーとか、エンジニアなら分かるんですが04/24のハンズオンの様子からそうじゃない人もユーザーになり得そうだったので、説明を厚くしました
- 内容量が多くなった関係で、READMEに置いておくとノイズになりそうだったのでquickstart.mdを作ってそちらで解説するようにしました
改行されてない？ように思ったので半角スペース2つの改行を採用しました
- ここについては要議論。改行タグを使うべきという考え方もある

レビューのお願い（ポイント）

明示的にver0.0.7としています。特にquickstart.md。バージョン表記は必要か？
- ユーザー的にはバージョンが書いてあった方がいいんですが、将来的に改修していく中でバージョンが上がった時、quickstartの内容が最新版ではないことを気にするユーザーが出てくる可能性があります。
- 雑にケアするなら「quickstartの内容で動く事」を担保してるよ、というのが良さそう
- CI/CDを実施するか？というとそこまででもない気がしてます。大掛かりな改修をする時にちょっとテストを考えるぐらいで良いのでは？感
READMEからhow to useを削ったが、大元の思想として良いのか？
- 削った理由は変更点の通り
- 当初は後述の方法でREADMEに組み込んだが、結局開閉させるのはどうなん？となったので廃止

<details>
  <summary>【クリックで展開】</summary>
</details>

所感

最近、まともに活動してなかったから運用も含めて色々考えられて楽しかったです

shimajima-eiji commented 6 months ago

@yasuraok いったんREADMEを差し戻しました。で、今回追加したPrompt_pathについて使い方欄に一行追記しています（READMEの確認用にビルドしたvsixファイルをSlackで送付します）

その上で、使い方欄でクイックスタート（quickstart.md）を案内する方式にしています（リンクチェックはできていないので、仮でREADMEへのリンクを貼って検証したところうまくいったのでおそらく大丈夫のはずです）

リンク先: https://github.com/yasuraok/SimpleTextRefine/blob/HEAD/quickstart.md

shimajima-eiji commented 6 months ago

副産物：VSCodeマーケットプレイスで開閉タグは使えるか？

A.できました

<details>
  <summary>【クリックで展開】</summary>

  簡易な使い方は[クイックスタート](quickstart.md)を参照

</details>

以下、わかりにくいですがVSCodeマーケットプレイスのキャプチャ

本PRでは採用を見送ってますが、必要であれば使えそうです。（とはいえ、視認性が悪くなるので非推奨かと）