solidjs / solidjs/solid-docs

[Content]: Typescript "Event handling" and "Advanced JSX attributes and directives" sections

オープン
#569 コメント 0 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

good first issue help wanted planned solid
主要言語
MDX
スター
292
フォーク
361
平均マージ
7時間 51分
マージ済み PR(30日)
1

説明

📚 Subject area/topic

Typescript "Event handling" and "Advanced JSX attributes and directives" sections

📋 Page(s) affected (or suggested, for new content)

https://docs.solidjs.com/configuration/typescript#event-handling
https://docs.solidjs.com/configuration/typescript#advanced-jsx-attributes-and-directives
https://docs.solidjs.com/configuration/typescript#custom-event-handlers

📋 Description of content that is out-of-date or incorrect
  • "Event handling" section and "custom event handler" section are split up, it makes more sense for these to be together
  • "custom event handler" section is currently under "Advanced JSX attributes and directives" along with "Forcing properties and custom attributes" and "Custom directives". I'm not sure it makes sense to have these split up. I feel like it would be easier to find if they were all just part of the list of API types. @LadyBluenotes let me know what you think about this one please.
  • "Forcing properties and custom attributes" and "Custom directives" are not a high enough level heading to show up in the page outline
  • "custom event handler" should be renamed since it also covers standard events, it is really just how to type on: both custom and standard events
  • standard events for on: are not included in SolidJS by default so the types have to be added manually, it should probably just be a subsection rather than a callout
🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

TypeScript ページの、リンクされた3つのドキュメントアンカーにあるセクション「イベント処理」、「高度な JSX 属性とディレクティブ」、「カスタムイベントハンドラー」から始めます。現在の見出しと内容を確認し、ページのアウトラインとイベントの型付けに関するガイダンスがより明確になるよう、関連するセクションを統合して名前を変更します。完了の条件は、対象となるトピックが論理的にグループ化され、標準およびカスタム on: イベントの両方を正確に説明していることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
半日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。