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

Not enough padding above headings

Open
#301 0 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

Chrome Version 88.0.4324.146 (Official Build) (x86_64) on macOS

Visit https://swagger.io/docs/specification/data-models/data-types/

See lots of text where sections don't stand out and are almost not recognized as things. It's really hard to read:

Numbers
Minimum/Maximum
Multiples
Strings
String Formats
pattern
Boolean
Null
Arrays
uniqueItems
Read-Only and Write-Only Properties
Nested Objects
Files
Any Type

Note that some items are actually ok:
image
image
image
image

Expected results:
More vertical padding before each item.

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

Open the linked data-types documentation page and compare the headings shown in the attached screenshots with the sections that already have adequate spacing. Locate the page's styling entry point, increase the vertical padding before the affected items, and confirm that the headings are visually distinct without disturbing the items that already look correct.

Written by the indexing model from the issue text.

Assessment

Domain
design, documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.