h3ravel/website

Docs: Write user docs for new features (console, sessions, API resources, helpers, broadcast, queue)

オープン

#8 opened on 2025/09/25

 (4 件のコメント) (0 件のリアクション) (0 人の担当者)SCSS (1 件のフォーク)auto 404
documentationgood first issue

Repository metrics

Stars
 (1 個のスター)
PR merge metrics
 (PR metrics pending)

説明

Background: Contributors and consumers need clear docs to use the new features.

Tasks:

  • Create a new docs section for each feature: Console, Core (Session), HTTP (Resources), Support (Helpers), Broadcast, Queue.

  • Each section must include:

    • Overview
    • Quick start with sample code
    • Configuration options
    • Common pitfalls and troubleshooting
  • Add code examples and short tutorials (e.g., build a small API using Resources, dispatch a queued job).

  • Add internal maintainers guide for testing and adding drivers.

Acceptance criteria:

  • A docs homepage includes links to all new sections.
  • Each section has at least a quick-start and one full example.
  • Docs are in Markdown and added to the console package's docs folder, sub folders can be created as neede.

Difficulty: medium

コントリビューターガイド