eclipse-iceoryx / eclipse-iceoryx/iceoryx2

Use Geoffrey to test rust code examples in markdown

Open
#12 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Rust
Stars
2.5k
Forks
185
Avg merge
1d 23h
Merged PRs (30d)
47

Description

## (Code) Example Of Cumbersome API

Currently, it can happen that due to some API adjustments code examples in the markdown files are no longer running. The [Geoffrey](https://github.com/ekxide/geoffrey) solves this problem.

## Improvement Suggestion

Only provide code examples in combination with geoffrey in markdown files.

Contributor guide

Open the contributing guide

Research direction

The issue names no files; start by locating the Rust code examples in the repository's markdown files and read Geoffrey's documentation. Determine how the examples can be checked with Geoffrey, then verify that the markdown examples are covered and remain runnable.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.