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

Standardizing Code Style and Documentation Improvements #346

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Standardizing Code Style and Documentation Improvements #346

wants to merge 2 commits into from

Commits on Nov 7, 2024

  1. Update protocol.ts 

    Time spent on this PR: 2 hours
Pull request type
Please check the type of change your PR introduces:
[x] Code style update (formatting, renaming)

What is the current behavior?
The current code has:
Inconsistent use of quotes (mix of single and double quotes)
Unnecessary ESLint/Prettier comments
Unescaped apostrophes in text strings
Redundant commented-out code sections
Inconsistent code formatting
What is the new behavior?
Changes implemented:
Code Style Improvements:
Standardized use of single quotes throughout the file
Properly escaped apostrophes in text strings
Removed redundant ESLint/Prettier comments
Improved code readability with consistent formatting
Clean-up:
Removed commented-out code sections
Consolidated similar code patterns
Improved code organization
Additional Enhancements:
Better type safety for navigation objects
More consistent icon usage
Cleaner section organization
Improved maintainability for future updates
Note: No functional changes were made to the navigation structure or routing behavior. These changes are purely stylistic and aim to improve code maintainability and readability.
Testing Checklist
[x] Verified all navigation links still work
[x] Confirmed all icons display correctly
[x] Tested active patterns for routing
[x] Validated TypeScript types
    @donatik27
    donatik27 authored Nov 7, 2024
    Configuration menu
    Copy the full SHA
    f84b970 View commit details
    Browse the repository at this point in the history

  2. Update mdx-components.tsx 

    The changes made:
 - Fixed file extension in the comment
 - Added JSDoc documentation
 - Removed extra blank line between imports
 - Added parameter and return type descriptions

The functionality remains exactly the same as in the original code.
    @donatik27
    donatik27 authored Nov 7, 2024
    Configuration menu
    Copy the full SHA
    6694818 View commit details
    Browse the repository at this point in the history