Improve Documentation

Open
#399 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
openapi, ruby
Domain
api, documentation

Research direction

The issue names no files, classes or methods, so first ask the maintainer which public APIs and configuration options should be covered. Then read the README and the gem's public entry points to find what is currently undocumented. Done means each chosen public API and option has a documented usage example that a newcomer can follow.

Written by the indexing model from the issue text.

Description

enhancement help wanted

There are quite a few ways to use this library and options to configure. I need some help to document the public APIs.

Dominant language
Ruby
Stars
222
Forks
27
Avg merge
17h 15m
Merged PRs (30d)
6

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No 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.

More from ahx/openapi_first

All issues in ahx/openapi_first

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.