OpenAPITools / OpenAPITools/openapi-generator

[BUG] Website: Generators navigation sidebar is misplaced for some generators

Open
#9,157 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: Ada Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

For specific generators on the website, the navigation sidebar is misplaced, appearing at the end of the page instead of on the side of it. Example (Java Generator):

Navigation menu at bottom screenshot

Browser:

  • Firefox 87.0 (64-Bit)
  • Microsoft Edge Version 89.0.774.63 (Official build) (64-bit)

Display resolution: 1920 * 1080

It also appears as if the table is cut off on the right side, which might be causing this? However, not all generators are affected, e.g. the page for ada shows the navigation sidebar.
(Though it might be good to move the navigation sidebar a little bit more to the right; the table for ada is rather squashed.)

Steps to reproduce
  1. Open https://openapi-generator.tech/docs/generators/java
  2. Look on the right
    ❌ There is no navigation sidebar
  3. Scroll down to the end of the page
    ❌ There is the navigation sidebar

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 reproducing the layout on https://openapi-generator.tech/docs/generators/java in Firefox or Edge, then compare it with the ada generator page. Check the generator documentation page layout around the navigation sidebar and wide table; done means the sidebar appears beside the content and the table is not improperly cut off on affected pages.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.