Skip to content

[Docs] Improve the formatting of documentation files #3409

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

Conversation

peter-csala
Copy link
Contributor

@peter-csala peter-csala commented May 19, 2025

Pull Request

The issue or feature being addressed

Details on the issue fix or feature implementation

Improvements

  • Update broken links
  • Use github's markdown alerts syntax for Note sections
  • Replace lambda functions' parameter names to more meaningful
  • Split those code blocks that contains code fragments for multiple files
  • Add syntax highlight for missing code blocks
  • Make the code blocks copy-paste ready

Done

@peter-csala
Copy link
Contributor Author

@martincostello Do you agree with the formatting improvements? If so, I'll apply the same for the rest of the files.

@codecov-commenter
Copy link

codecov-commenter commented May 19, 2025

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.55%. Comparing base (91b05c6) to head (896c92d).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3409   +/-   ##
=======================================
  Coverage   93.55%   93.55%           
=======================================
  Files         110      110           
  Lines        3834     3834           
  Branches      719      719           
=======================================
  Hits         3587     3587           
  Misses        247      247           
Flag Coverage Δ
Linux 93.55% <ø> (ø)
Windows 93.55% <ø> (ø)
macOS 93.55% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Collaborator

@martincostello martincostello left a comment

Choose a reason for hiding this comment

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

Looks good overall - just a few style suggestions.

@peter-csala peter-csala marked this pull request as ready for review May 20, 2025 11:20
@martincostello martincostello merged commit bd778bc into domaindrivendev:master May 20, 2025
9 checks passed
This was referenced Aug 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants