h3ravel/website
Docs: Write user docs for new features (console, sessions, API resources, helpers, broadcast, queue)
Offen
#8 geöffnet am 25.09.2025
documentationgood first issue
Repository-Metriken
- Stars
- (1 Stern)
- PR-Merge-Metriken
- (PR-Metriken ausstehend)
Beschreibung
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
docsfolder, sub folders can be created as neede.
Difficulty: medium