Improve LeadForge README presentation#101
Merged
Merged
Conversation
shaypal5
added
documentation
|
pr-agent-context report: No unresolved review comments, failing checks, or actionable patch coverage gaps were found on PR #101 in repository https://github.com/leadforge-dev/leadforge. Treat this PR as all clear unless new signals appear.Run metadata: |
There was a problem hiding this comment.
Pull request overview
This PR improves the repository’s GitHub landing-page README so first-time visitors can quickly understand LeadForge, find the hosted docs, and see a concrete example of generated output.
Changes:
- Add top-of-page badges (CI, docs, license, Python version) and prominent docs/dataset links near the introduction.
- Add a “What Makes LeadForge Different” section plus a compact generated-data preview table.
- Replace local documentation links with public docs-site URLs and update the Credits block formatting.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **Opinionated framework for generating synthetic CRM and GTM datasets from simulated commercial worlds.** | ||
|
|
||
| Created by [Shay Palachy Affek](https://www.shaypalachy.com/). | ||
| Created by [Shay Palachy Affek](http://www.shaypalachy.com/). |
| ## Credits | ||
|
|
||
| Created by [Shay Palachy Affek](https://www.shaypalachy.com/) · [HuggingFace](https://huggingface.co/shaypal5) · [Kaggle](https://www.kaggle.com/derelictpanda) · [GitHub](https://github.com/shaypalachy) | ||
| Created by [Shay Palachy Affek ](http://www.shaypalachy.com/) [[GitHub](https://github.com/shaypal5)] |
| | train | logistics | UK | 500-999 | inbound_marketing | 5 | 2 | False | 58,372 | False | | ||
| | train | logistics | US | 200-499 | partner_referral | 9 | 3 | True | 15,462 | False | | ||
| | train | healthcare_non_clinical | US | 200-499 | inbound_marketing | 5 | 1 | True | 30,490 | False | | ||
| | train | manufacturing | US | 1000-1999 | sdr_outbound | missing | 1 | True | 42,999 | False | |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Improve the GitHub landing-page presentation for LeadForge so a first-time visitor can immediately understand the project, find the docs, and see what generated output looks like.
Changes
GitHub metadata
Updated directly on the repository card with
gh repo edit:Opinionated framework for generating synthetic CRM and GTM datasets from simulated commercial worlds.https://leadforge-dev.github.io/leadforge/synthetic-data,crm,gtm,lead-scoring,python,teachingValidation
git diff --check -- README.mdNotes
A pre-existing local edit to
release/kaggle/dataset-metadata.jsonwas intentionally left unstaged and is not part of this PR.