PokeAPI / PokeAPI/pokeapi

Docs(OpenAPI): Update Descriptions and Examples

Open
#1,255 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
5.4k
Forks
1.2k
Avg merge
2d 5h
Merged PRs (30d)
21

Description

[!NOTE]

WIP

More details to come...

Update the API property descriptions using the data found in pokeapi.co repo docs.

Dependency:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the API property descriptions and examples in the repository, then compare them with the source documentation in the linked pokeapi.co repository. Confirm that dependency issue 162 is resolved before beginning. Done means the API descriptions and examples reflect the referenced source documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, 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.