Skip to content

docs: add related projects page - #1899

Merged
kingthorin merged 1 commit into
datafaker-net:mainfrom
kingthorin:docs-related-projects
Aug 10, 2026
Merged

docs: add related projects page#1899
kingthorin merged 1 commit into
datafaker-net:mainfrom
kingthorin:docs-related-projects

Conversation

@kingthorin

@kingthorin kingthorin commented Aug 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Add a Documentation page for complementary JVM tools, with Java/Kotlin examples pairing Datafaker's Address provider and address-formatter-java
  • Wire the page into mkdocs.yml nav and link short ecosystem notes from the README (datafaker-gen, datafaker-native-demo)

Document complementary JVM tools such as address-formatter-java
with Java/Kotlin examples pairing Datafaker Address output.
@what-the-diff

what-the-diff Bot commented Aug 10, 2026

Copy link
Copy Markdown

PR Summary

  • Addition of New Section in README.md
    The README.md file has been updated with a new section titled "RELATED PROJECTS". This section provides links and descriptions of tools that complement Datafaker, such as an Address formatting tool with address-formatter-java, a Command Line Interface (CLI) generator, and a Native image demo.

  • Introduction of New Documentation File
    A new documentation, related-projects.md, has been added. This document provides in-depth information about various projects related to Datafaker. It includes an example of address formatting using address-formatter-java, along with how-to guides involving snippets and code examples in both Java and Kotlin languages.

  • Navigation Update in mkdocs.yml
    The navigation in the project documentation's outline has been updated by adding a new entry labeled as "Related projects". This ensures easy access to the detailed document about projects related to Datafaker.

@codecov-commenter

Copy link
Copy Markdown

⚠️ 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 92.54%. Comparing base (edb06c2) to head (88c6ce2).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1899      +/-   ##
============================================
+ Coverage     92.49%   92.54%   +0.04%     
- Complexity     3570     3571       +1     
============================================
  Files           347      347              
  Lines          7052     7052              
  Branches        675      675              
============================================
+ Hits           6523     6526       +3     
+ Misses          367      365       -2     
+ Partials        162      161       -1     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@asolntsev asolntsev added the documentation Improvements or additions to documentation label Aug 10, 2026
@asolntsev asolntsev added this to the 3.0.0 milestone Aug 10, 2026
@kingthorin
kingthorin merged commit 4f5b2ac into datafaker-net:main Aug 10, 2026
17 checks passed
@kingthorin
kingthorin deleted the docs-related-projects branch August 10, 2026 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants