search

kenkoooo / AtCoderProblems

Extend your AtCoder
https://kenkoooo.com/atcoder/
MIT License
1.41k stars 150 forks source link

ユーザーガイドを作る #993

Open kenkoooo opened 3 years ago

kenkoooo commented 3 years ago

907 でユーザーガイドを作り始めようとしたが、やる気が続かなかった。

polyester-CTRL commented 2 years ago

作ってみたいです！

kenkoooo commented 2 years ago

お願いします！

polyester-CTRL commented 2 years ago

ガイドの項目や、ファイル構成はPull Requestの #907 を参考にしようと考えています。 それでよろしいでしょうか？

kenkoooo commented 2 years ago

正直 #907 をどんな気持ちで作ろうとしていたか完全に忘れてしまったのですが、たぶんいいと思います！

ファイル構成については全然こだわりはないのですが、 #907 では mdBook というツールを使って markdown からウェブ本を自動生成しようとしていて、このファイル構成は mdbook 用のものだった記憶があります。

polyester-CTRL commented 2 years ago

ありがとうございます！ markdownから自動生成する手法は、編集の手間がかからない点から採用したいと思います。

polyester-CTRL commented 2 years ago

開発者向けの情報はこちらを全部コピペすれば完成してしまうのでは？と思っています。 https://kenkoooo.hatenablog.com/entry/2019/12/01/011525

いかがでしょうか？

kenkoooo commented 2 years ago

開発者向け情報はゼロで大丈夫です！

polyester-CTRL commented 2 years ago

分かりました。ちなみに優先順位を付けるとしたらどんな情報（問題の探し方、バーチャルコンテスト関係、トレーニングモードなど）から作るといいでしょうか？

kenkoooo commented 2 years ago

全くのゼロなので、好きなところ初めていただいて構いません！自分がよく使う機能から書くのが書きやすそうです。類似の記事を見た感じ、問題の探し方が一番需要がありそうです。

https://ntk-ta01.hatenablog.com/entry/2020/04/15/001405 https://note.com/momomo0214/n/nc38bb4ea82aa

polyester-CTRL commented 2 years ago

https://github.com/polyester-CTRL/AtCoderProblems/tree/feature/993/guide-ja とりあえず本文を一通り書きました。 端末上でAtCoderProblems/guide-ja/に移動して、mdbook serveと入力するとユーザーガイドをlocalhost:3000にてブラウザから確認できます。 説明の中で気になる箇所があれば、指摘を頂けると助かります。

この後に、このユーザーガイドへのリンクをどこかに貼る作業が必要だと思います。ですが、どうするのがベストなのか分からないので何もしていません。アドバイスを頂けると助かります。

kenkoooo commented 2 years ago

いったんプルリクを作っていただいて、細かいことは後で考えるということで良いと思います。

polyester-CTRL commented 2 years ago

プルリクエストを作りました。確認をお願いします。