You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3, because the PR involves multiple files and changes in both content and style, requiring a detailed review of both the functionality and the visual aspects.
🧪 Relevant tests
No
⚡ Possible issues
CSS Specificity: The new CSS rules added might have higher specificity which could override other styles unintentionally.
Inline Styles: Usage of inline styles in HTML increases maintenance difficulty and reduces scalability.
🔒 Security concerns
No
Code feedback:
relevant file
tyk-docs/assets/scss/_docs.scss
suggestion
Consider using a class instead of inline styles for .badge .nav.bottom-title to maintain consistency and ease of maintenance. [important]
Avoid using inline styles for padding in the <article> tag to enhance CSS maintainability. Consider adding a class and defining these styles in a CSS file. [important]
Replace the non-standard CSS property with a valid one
The CSS property text-wrap is not a standard CSS property. You might have intended to use white-space, word-wrap, or overflow-wrap. Please replace text-wrap with a valid CSS property to ensure the styles are applied correctly.
.badge center p {
- text-wrap: balance;+ word-wrap: break-word;
font-weight: 500;
}
Suggestion importance[1-10]: 10
Why: The suggestion correctly identifies and fixes a non-standard CSS property text-wrap to word-wrap, which is crucial for the CSS to function properly in browsers.
10
Remove the duplicate color property to avoid styling conflicts
The CSS rule .badge .nav.bottom-title specifies the color property twice with different values (white and $brand-black). This could lead to confusion and unintended styling. Consider removing one of the color properties to maintain consistent styling.
Why: The suggestion correctly points out the issue of having two conflicting color properties in the same CSS rule, which can cause styling issues and confusion.
8
Possible bug
Ensure HTML tags are opened and closed within the same conditional block to avoid invalid HTML
The
tag is opened inside a conditional block but closed outside of it. This could lead to invalid HTML structure if the condition is not met. Ensure that the
tag is properly opened and closed within the same conditional block.
Why: This suggestion addresses a potential issue where HTML structure could become invalid due to conditional rendering, which is crucial for maintaining valid HTML output.
9
Maintainability
Move inline styles to a CSS class to improve code maintainability
The inline styles added to the
tag can lead to difficulties in maintenance and override issues. Consider moving these styles to a CSS class in the stylesheet. This will improve maintainability and make the styles easier to manage.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
For internal users - Please add a Jira DX PR ticket to the subject!
Preview Link
Description
Screenshots (if appropriate)
Checklist
master
.PR Type
enhancement, documentation
Description
Changes walkthrough 📝
_docs.scss
Enhance badge styling for plugin hub
tyk-docs/assets/scss/_docs.scss
font settings.
baseof.html
Add conditional padding to page content
tyk-docs/themes/tykio/layouts/_default/baseof.html
page parameters.
badge.html
Update badge shortcode for centered titles and new bottom-title
tyk-docs/themes/tykio/layouts/shortcodes/badge.html
plugin-hub.md
Create Plugin Hub page with plugin entries
tyk-docs/content/plugin-hub.md
descriptions.
menu.yaml
Add Plugin Hub to documentation menu
tyk-docs/data/menu.yaml