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

docs: Improve Best Practices Guide for Elysia.js #1114

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Ahmedabbas03
Copy link

This pull request improves the Best Practices guide for Elysia.js. The updates make the content clearer and more consistent.

Key Improvements

  • Grammar & Clarity

    • Corrected grammatical errors for better readability.
    • Improved sentence structure for clearer explanations.
  • Consistency

    • Used a uniform writing style (e.g., consistently referring to "Elysia.js" or "Elysia").
    • Standardized phrasing (e.g., "should" vs. "recommended").
  • Code Readability

    • Maintained consistent formatting and indentation.
    • Added concise comments where necessary for clarity.
    • The section on method chaining now explains its importance for type integrity.
    • The controller section is simplified to keep things clear and type-safe.
    • The services section shows how to create non-request dependent services with better examples.

These changes aim to help developers follow best practices when using Elysia.js.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant