Version indicator for rendered examples

オープン
#4,533 コメント 1 件 リアクション 4 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
react
領域
documentation

調査の方向性

まず、リンクされた Date Time Picker Lit、React、Flow のサンプル URL を、埋め込みサンプル、Show code セレクター、Open in a new tab アクションと比較します。完了とは、ユーザーが埋め込みサンプルと開いたサンプルでレンダリングされたバージョンを特定でき、自分の選択と異なる場合を理解し、利用可能なバージョンを確認できる状態です。

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

説明

#4400 changed the Docs to always render the React example if available, regardless of the selected source code type. This causes some issues.

  • Currently it isn't indicated to the users in any way that the rendered example doesn't match the source code selection.
  • You can still view e.g. the Flow example by clicking the "Open in a new tab" button at the corner when you have Flow selected for displaying the source code, but it likewise isn't indicated in any way that this is necessary, or that it possibly opens something else than what you already see.
  • If you do open to a new tab, what you see there doesn't indicate which version it belongs to either, or whether it matches what you saw in the embedded version. You can't easily decipher this from the new URL either.
  • You can't even see the version selection without first clicking 'Show code', so you might be initially looking at an embedded React example and accidentally open a Lit example to a new tab when you are actually trying to check out how the feature behaves in Flow.
  • Presumably if one of these versions didn't exist at all, it would open some other version in the new tab without the user being none the wiser.

E.g. the first example about Date Time Picker component currently links to these pages: Lit, React, Flow

The Lit URL above doesn't even mention Lit, and the Flow URL doesn't mention Flow but it does mention React even if it's apparently still the Flow example in reality.

Obviously none of this is very ideal and it's confusing to users and staff members both.

  • It would be nice to have some small indicator in the embedded example already on what version is rendered there -- if I understood correctly it's not even always React, it might still be Lit or Flow of there is no React version available. This indicator could be e.g. an icon or a letter.

    • Bonus points if there would be an info button or a tooltip or something else that explains what the indicator means -- and, if that's indeed the case, why the displayed version doesn't match the selected version in the code examples. If this explanation is very long, it could link to some FAQ instead.
  • It would also be nice to have some small indicator in the opened tab on which version was actually opened there.

    • Bonus points if the indicator could be clickable to expand a version list that would indicate which other versions are actually available and redirect you there upon selection.

If you think this issue is important, add a 👍 reaction to help the community and maintainers prioritize this issue.

主要言語
AsciiDoc
スター
38
フォーク
225
平均マージ
17時間 38分
マージ済み PR(30日)
214

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

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

vaadin/docs のほかの issue

vaadin/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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