h3ravel/website

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

Aperta

#8 aperta il 25 set 2025

Vedi su GitHubGuida contributor
 (4 commenti) (0 reazioni) (0 assegnatari)SCSS (1 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (1 stella)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Familiarizzati con ciascuna funzionalità leggendo il codice sorgente e i test esistenti nel repository principale del framework. Poi scrivi una documentazione Markdown chiara seguendo le sezioni delineate.
Tech stack
php
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
MarkdownGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70