quarkiverse/quarkus-dapr

Reorganize documentation

Open

#212 opened on Sep 17, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (20 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (37 stars)
PR merge metrics
 (PR metrics pending)

Description

  • Add installation section first
  • Use dependency version with {project-version} attribute
  • Use examples with CloudEvents<>
  • Fix extension configuration reference

Contributor guide

Research direction
Review the existing documentation structure, identify sections to reorganize as per the checklist, update version placeholders, and ensure examples use correct CloudEvents syntax.
Tech stack
java
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80