GitHub / picoruby/picoruby.github.io issues and pull requests

#22 - WiFi config page for R2P2

Pull Request - State: closed - Opened by hasumikin 4 months ago

#21 - Update ESP32 column in Porting table.

Pull Request - State: closed - Opened by yuuu 4 months ago

#20 - Added status of porting to ESP32 to PicoRuby documentation.

Pull Request - State: closed - Opened by yuuu 6 months ago - 1 comment

#19 - mruby/cがmodule機能を（限定的に）実装したのでドキュメントの仕組みもmoduleに対応しなきゃならない！

Issue - State: open - Opened by hasumikin 11 months ago

#18 - Fix tags

Pull Request - State: closed - Opened by maimux2x over 1 year ago

#17 - Fixed 404 error on tag_introduction.html

Pull Request - State: closed - Opened by maimux2x over 1 year ago - 1 comment

#16 - ドキュメント内の静的コンテンツとして関連記事へのリンクとかコラムを新たに書くとかもやっていけたらよさそう

Issue - State: open - Opened by hasumikin over 1 year ago

#15 - この自動生成の仕組みに汎用性を持たせてgem化する。jekyll pluginでもよいかも。このためにはPicoRubyには（いまのところは）ないmoduleにも対応する必要がある。PicoRubyにもmodule機能が入るかもしれないので、やっておくとよさそうではある

Issue - State: open - Opened by hasumikin over 1 year ago

#14 - RBSにはオプショナル引数のデフォルト値の情報が含まれない。たとえばrbファイルでは`def m(a=0)`となっている場合に、rgsでは`def m: (?Integer a)`となっていて、aのデフォルト値が0であることがわからない。デフォルト値をドキュメント化したいので、いいやり方がないか考えたい（コメントに書くとかでもいい思うが、rb実装との二重管理になってしまうから、rb実装ファイルから自動的に持ってこられるとありがたい）

Issue - State: open - Opened by hasumikin over 1 year ago

#13 - GitHub Action：picoruby/picoruby（masterブランチ）へのプッシュ時にrbsファイルが変更されていたらpicoruby/picoruby.github.ioを自動で更新するようにしたい

Issue - State: open - Opened by hasumikin over 1 year ago

#12 - privateメソッドは現状ドキュメンテーションに含めていないが、privateセクションを設けて載せるようにしてもいいかもしれない。ただし`@ignore`が注釈されていたら載せない

Issue - State: open - Opened by hasumikin over 1 year ago

#11 - 定数もドキュメント化したい

Issue - State: open - Opened by hasumikin over 1 year ago

#10 - いまは（画像参照）`member[:souce]`（`(Integer) -> 0`みたいな素のテキスト）を生成ドキュメントにそのまんま使用しているが、`member[:required_positionals]`以下の情報（現在は未使用）を組み合わせてドキュメントを生成するようにしたい。これができると、たとえば`Integer`という型名から`Integer.html`へリンクできるのではないかと思っている。type_aliasも同様にリンクしたい

Issue - State: open - Opened by hasumikin over 1 year ago

#9 - 継承（superクラス）についての情報を載せたい

Issue - State: open - Opened by hasumikin over 1 year ago

#8 - あわせて、picoruby/mrbgems/picoruby-mrubyc/sig/*.rbs（つまりPicoRubyコアライブラリの型情報）の多くは、rbs gemがもっているCRubyコアの型ファイルをコピってきてsteep checkが通るだけの状態へ雑に編集しただけのもの。パクってきたときにいっしょについてきた元々のコメントには解説文（riで読めるやつ）がくっついているので、これの記法も整合性をとる必要あり

Issue - State: open - Opened by hasumikin over 1 year ago

#7 - rbsファイル内のclass定義やメソッド定義にマークダウン（？）でコメント（用例など）を書くと、それがドキュメントにも載るようにしたい。注意点としては、すでにコメント部分には機能があって、`@sidebar` `@added_by` `@ignore`という注釈がmd生成に影響を与えているので、そことの整合性を設計する必要あり

Issue - State: open - Opened by hasumikin over 1 year ago

#6 - tagsの機能がうまく動いていない（たとえば https://picoruby.github.io/tag_introduction.html が404）

Issue - State: open - Opened by hasumikin over 1 year ago

#5 - picoruby/mrbgems/picoruby-mrubyc/sig/*.rbsは、rbs gemがもっているCRubyコアの型ファイルからパクってきてsteep checkが通るだけの状態へ雑に編集しただけのもの。不正確な情報（とくにオーバーロードの型情報やコメント部に書かれた文書。mrubycは同じメソッド名でも機能が限定されていることが多い）が含まれているので、これを直していきたい

Issue - State: open - Opened by hasumikin over 1 year ago

#4 - rbsのメソッド定義に引数名をなるべく書き足す。たとえば、現状`def m: (Integer)`となっているなら、`def m: (Integer a)`のように引数の変数名を書き加えたい（rbファイルのほうに`def m(a);...;end`のように書いてあるから、それを見て補う）。変数名が不適切だったら、ついでに直しちゃってもよい

Issue - State: open - Opened by hasumikin over 1 year ago

#3 - diff of setup

Pull Request - State: closed - Opened by maimux2x over 1 year ago

#2 - Fix a typo

Pull Request - State: closed - Opened by ydah over 1 year ago

#1 - ROAD MAP

Issue - State: open - Opened by hasumikin over 1 year ago