eclipse-iceoryx / eclipse-iceoryx/iceoryx

Ongoing Issue: Small Documentation Tasks

Open
#2,305 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
C++
Stars
2.2k
Forks
492
Avg merge
18h 57m
Merged PRs (30d)
1

Description

## Brief feature description

This is an accumulation issue for all the small documenations tasks. No matter if it is a typo to fix or changing a README. Instead oh having to create issues with a one-liner all the time, this one can be used.

This is not intended to be used for creating extensive documentation like design documents or similar but only for small fixes.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the repository README and the documentation areas relevant to the specific typo or small documentation fix you choose. Confirm the requested wording or correction with the issue context, then verify that the targeted documentation change is complete without expanding the scope into extensive design documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.