h3ravel/website

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

開放

#8 建立於 2025年9月25日

 (4 則留言) (0 個反應) (0 位負責人)SCSS (1 個分叉)auto 404
documentationgood first issue

倉庫指標

星標
 (1 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

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

貢獻者指南