eiffel-community / eiffel-community/eiffel-graphql-api

Add examples to documentation

Open
#3 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Python
Stars
4
Forks
6
PR merge metrics
No merged PRs in 30d

Description

### Description

More examples will make this easier to use.

### Motivation

### Exemplification

### Benefits

### Possible Drawbacks

Contributor guide

Open the contributing guide

Research direction

Start by locating the documentation for the Eiffel GraphQL API and reviewing its existing examples and usage flow. The issue names no documentation file, example scenario, or test, so first determine where examples belong and what gap they should address. Done means adding concrete, consistent examples that make the API easier to use and verifying the documentation renders correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, mongodb, python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.