Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: openapi docs improvements #1344

Merged
merged 9 commits into from
Dec 12, 2024
Merged

fix: openapi docs improvements #1344

merged 9 commits into from
Dec 12, 2024

Conversation

B4nan
Copy link
Member

@B4nan B4nan commented Dec 11, 2024 •
edited
Loading

  • unify sidebar and content badges for method type (post/put/create/delete/...)
  • render category index pages
  • hide next/prev buttons from openapi docs pages
  • remove descriptions from generated category index of openapi docs
  • add missing syntax highlighting and use custom language order and labels
  • enable docusaurus 3.6 perf optimizations expect SWC loader (not working with styled components)

@B4nan B4nan changed the title fix: remove descriptions from generated category index of openapi docs fix: openapi docs improvements Dec 11, 2024
@github-actions github-actions bot added this to the 104th sprint - Tooling team milestone Dec 11, 2024
@github-actions github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Dec 11, 2024
@B4nan B4nan mentioned this pull request Dec 11, 2024
Open
@B4nan B4nan added the adhoc Ad-hoc unplanned task added during the sprint. label Dec 11, 2024
@B4nan B4nan force-pushed the openapi-docs-fixes branch from 1671724 to a54e81d Compare December 11, 2024 18:16
@B4nan B4nan requested a review from TC-MO December 12, 2024 10:14
TC-MO
TC-MO reviewed Dec 12, 2024
View reviewed changes
Copy link
Contributor

@TC-MO TC-MO left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just one nit, shouldn't we go with proper names of languages instead of making them lowercase? ie. JavaScript not javascript, PHP not php , etc. in the right side component?

image

Disregard all work as intended

image

TC-MO
TC-MO approved these changes Dec 12, 2024
View reviewed changes
Copy link
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@B4nan B4nan merged commit d0ae355 into master Dec 12, 2024
8 checks passed
@B4nan B4nan deleted the openapi-docs-fixes branch December 12, 2024 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TC-MO TC-MO TC-MO approved these changes

Assignees

@B4nan B4nan

Labels
adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.
Projects
None yet
Milestone
104th sprint - Tooling team
Development

Successfully merging this pull request may close these issues.
2 participants
@B4nan @TC-MO