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.

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

[Enhancement] Introduce new theme component names: ApiExplorer, CodeSnippets #577

Merged
merged 3 commits into from
May 15, 2023

Conversation

blindaa121
Copy link
Collaborator

@blindaa121 blindaa121 commented May 11, 2023

Description

This PR consists of renaming the following theme components:

  • ApiDemoPanel to ApiExplorer
    • Rename instances of openapi-demo class names to openapi-explorer
  • Curl to CodeSnippets

Motivation and Context

Component names should reflect the nature of their functionality as closely as possible.

How Has This Been Tested?

Tested locally to ensure that components above now reflect their updated names.

Types of changes

  • New feature (non-breaking change which adds functionality)

Checklist

  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes if appropriate.
  • All new and existing tests passed.

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature.
MadVikingGod Aaron Clawson
@blindaa121 blindaa121 added enhancement New feature or request DO NOT MERGE labels May 11, 2023
@blindaa121 blindaa121 self-assigned this May 11, 2023
@github-actions
Copy link

github-actions bot commented May 11, 2023

Visit the preview URL for this PR (updated for commit 6649cf6):

https://docusaurus-openapi-36b86--pr577-l3pzowgl.web.app

(expires Wed, 14 Jun 2023 20:17:09 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@blindaa121 blindaa121 changed the title [Enhancement] Introduce new theme component names: ApiExplorer, CodeSnippets, ExpandModal [Enhancement] Introduce new theme component names: ApiExplorer, CodeSnippets May 15, 2023
@blindaa121 blindaa121 requested a review from sserrata May 15, 2023 16:37

Verified

This commit was signed with the committer’s verified signature.
MadVikingGod Aaron Clawson
@sserrata
Copy link
Member

FYI, the ApiCodeBlock class renames also addresses #576

Copy link
Member

@sserrata sserrata left a comment

Choose a reason for hiding this comment

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

LGTM

@blindaa121 blindaa121 merged commit f3f9a40 into v2.0.0 May 15, 2023
@blindaa121 blindaa121 deleted the rename-components branch May 15, 2023 21:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants