Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flutter Webによるdocsビューワの作成 #299

Merged
merged 4 commits into from
Aug 1, 2024
Merged

Conversation

mj-hd
Copy link
Collaborator

@mj-hd mj-hd commented Aug 1, 2024

概要

  • refer: [Improve]: ドキュメントを見やすくしたい #264
  • Flutter Webを使ってMarkdownを表示する簡易的なアプリを作成しました
  • かなりシンプルに、Markdownを表示して外部リンクへ飛べるようにした程度です
    • 完成ではないですが、一旦現段階でPRを出します

レビュー観点

レビューレベル

  • Lv1: ぱっとみて違和感がないかチェックして Approve する
  • Lv2: 仕様レベルまで理解して、仕様通りに動くかある程度検証して Approve する
  • Lv3: 実際に環境で動作確認したうえで Approve する

レビュー優先度

  • すぐに見てもらいたい ( hotfix など ) 🚀
  • 今日中に見てもらいたい 🚗
  • 今日〜明日中で見てもらいたい 🚶
  • 数日以内で見てもらいたい 🐢

画像 / 動画

image

確認したこと

  • 各ドキュメントが見れること
  • リロードしても該当ページに直接アクセスできること(URLから正常にルーティングできること)

動作確認手順

  • ローカルで実行する

備考

今後のTODO:

  • 内部リンクを正常に動作させること (onTapLinkのhrefを見てrouterでgoする)
  • 画像表示を正常に動作させること(Assetから画像を読んで表示する)
  • Codeブロックが見づらいので、見た目を整えること
  • Github Pagesに自動デプロイするフロー

Copy link

github-actions bot commented Aug 1, 2024

Visit the preview URL for this PR (updated for commit 163e289):

https://flutter-mobile-project-template-catalog--pr299-docs-we-nhexnejs.web.app

(expires Thu, 08 Aug 2024 08:14:44 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 9ea56735a63d07a7cfe62eb204b0528284c37c23

@mj-hd mj-hd marked this pull request as ready for review August 1, 2024 06:56
@yumemi-team-review-requester yumemi-team-review-requester bot requested review from a team, takashi0602 and morikann and removed request for a team August 1, 2024 06:56
@mj-hd
Copy link
Collaborator Author

mj-hd commented Aug 1, 2024

手元の環境起因でlabeler, labelsの生成に失敗していて、CI落ちてますが、その他の部分見ていただけたらと思います
(手元の環境は修復中です...少々お待ちを...)

Copy link

github-actions bot commented Aug 1, 2024

Ready for review 🚀

@mj-hd mj-hd requested a review from blendthink August 1, 2024 06:57
@mj-hd mj-hd marked this pull request as draft August 1, 2024 07:22
@mj-hd
Copy link
Collaborator Author

mj-hd commented Aug 1, 2024

Cleanupでファイル削除するのを忘れていたので、一度Draftに戻します 🙏

@mj-hd mj-hd marked this pull request as ready for review August 1, 2024 07:40
@mj-hd
Copy link
Collaborator Author

mj-hd commented Aug 1, 2024

Draft解除しました

Copy link

github-actions bot commented Aug 1, 2024

Ready for review 🚀

@blendthink
Copy link
Member

blendthink commented Aug 1, 2024

@mj-hd
ご対応ありがとうございます 🎉

ただ、 CI がこけているみたいですので、ご確認お願いします🙏
大した修正ではないので、↑自分のほうで対応してコミットしちゃおうと思います!

Copy link
Member

@blendthink blendthink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

コード的には問題なさそうです!

ただ、 CI がこけているのでご確認お願いします🙏
おそらく、ラベルの設定の差分が出ていそうです!

大した修正ではないので、↑自分のほうで対応してコミットしちゃおうと思います!

@@ -3,6 +3,8 @@ removal_list_on_use_template.txt

LICENSE.md

apps/website
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good-badge
ご対応ありがとうございます!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good-badge
このやり方いいですね✨

Comment on lines +5 to +6
# Webを前提とするプロジェクトなので無効化
avoid_web_libraries_in_flutter: false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good-badge
👍

Comment on lines +3 to +4
This is a web document viewer.
You can view the markdown documents in the `docs/` directory by this app.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good-badge
😍

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

memo-badge
マージする前に削除するの忘れないようにする

@blendthink blendthink merged commit 99c5577 into main Aug 1, 2024
15 checks passed
@blendthink blendthink deleted the docs-website branch August 1, 2024 08:20
@mj-hd
Copy link
Collaborator Author

mj-hd commented Aug 2, 2024

@blendthink すみません、ご対応ありがとうございます!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants