ページ構成の再検討・チュートリアルの追加

[su8ru]

現状では、「初心者向けのチュートリアル」と「仕様のリファレンス」が混ざってしまっています
（私の Qiita 記事をベースに作ってしまったので、どうしてもチュートリアル要素が強い）
そこでページ構成を変え、チュートリアルとリファレンスを分離するのが目的です

また「Frourio の機能のリファレンス」と「Fastify / Express の機能の導入ガイド」が混在している状態を解消する狙いもあります

最初から create-frourio-app を使うとすべて出揃ってしまいチュートリアルの意味が無いので、@LumaKernel さんの ハンズオン のように最小構成から積み上げていくほうがいいのかもしれません

これらはまだ案なので、公式ドキュメントにチュートリアルが必要かという点を含め、ご意見お待ちしています

• チュートリアルをドキュメントから分離 #81
• リファレンス整備 #82
• チュートリアルの全面的な書き直し #83

ページ構成 [案]

✏️ … 新規書き下ろし

• トップページ
  Reference と Tutorial の分岐

Docs

• ✏️ About Frourio
  「Frourio とはなにか？」「Why Frourio?」
• ✏️ Reference
  主要機能の詳細
  • create-frourio-app
    yarn create frourio-app
  • Aspida
    エコシステムのどこを担うのか
  • Controller
    GET, POST の実装やパス引数の実装
  • Hooks
    Lifecycle と Hooks の種類・レベル
  • AdditionalRequest
    Hooks と Controller の橋渡しの例
  • Validation
    自動 validate と class-validator
• Guide (Best Practice?)
  「これしたい！」へのベストプラクティス
  • Custom Entrypoint
  • Authentication
  • CORS / Helmet
  • ORM
  • 500 Error Handling
  • Dependency Injection
  • Typed Pages Path (Pathpida)
  • ✏️ Deployment (CI / CD) … CI のページの必要性についてはやや疑問
  • Improve Performance
• API
  • CLI Command ( "CLI" ページを作る #37 )
  • defineController
  • defineHooks

Tutorial

create-frourio-app を使わずに Frourio と Aspida を導入する

• ✏️
  • Preparation
  • Install Aspida
  • Create Controller
  • Add Hooks
  • Add Validator

[solufa]

「初心者向けのチュートリアル」の拡充は嬉しいポイントですね
cfaが巨大なだけでfrourio本体は小さくて設定や覚えることが少ないというのも伝えたい
「frourio気持ちいい！」と体感できる確率を上げる施策として親切なチュートリアルが欲しい

[ghost]

Aboutに 思想を書くといいかもと思いました
例)「何故frourioを作成したか」「何を解決したかったのか」

[LumaKernel]

Why frourio(motivation)とWhat frourioはいいですね! OSSなど使う際はまずここを見ます。何なんだ、と。
しかし不思議なことに、私はfrourioはCFAで作ったときすごく気に入ってそこから仕組みを見ていくことができましたね…最初見たときはfrourioとaspidaの境界がわからなくて。

ハンズオンはその方向性を逆転しようとした形です

[LumaKernel]

frouriojs/create-frourio-app#341 (comment)

import CFA from "create-frourio-app/lib/main"
<CFA />

docusaurus がどれくらい拡張性あるかわかりませんが、Reactであれば上記の方法で、コピペ版のCFAが埋め込めると思います。