swagger-api / swagger-api/swagger.io-docs

This repository is drastically behind swagger.io

Open
#289 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Astro
Stars
1.6k
Forks
407
Avg merge
2m
Merged PRs (30d)
2

Description

At the bottom of the pages on swagger.io, it says:

Found a mistake? Let us know

and links to https://github.com/swagger-api/swagger.io/issues. However, the contents of this repo are very far behind the web site. Swagger.io covers version 3.x, e.g. here: https://swagger.io/docs/specification/basic-structure/ but https://github.com/swagger-api/swagger.io/blob/wordpress/docs/spec-explained/basic-structure.md talks about 2.x.

Where does one find the source for the current web site?

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 comparing the swagger.io Basic Structure page with wordpress/docs/spec-explained/basic-structure.md and the repository contents. Trace where the current website content is sourced, then document the repository or path that corresponds to the live 3.x page.

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
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.