Restructure README: fix heading hierarchy, hoist inclusion criteria - #28
Open
davanstrien wants to merge 1 commit into
Open
Restructure README: fix heading hierarchy, hoist inclusion criteria#28davanstrien wants to merge 1 commit into
davanstrien wants to merge 1 commit into
Conversation
The Datasets, Libraries and Papers sections were nested as `###` under "Important techniques", so they rendered as sub-parts of it rather than as top-level sections. Promote them to `##`. Other structural changes, no content edits: - Rename "Resources" to "Scope and inclusion criteria" and pull the editorial policy up from where it was buried inside the Libraries and Papers sections, so it applies to the whole list. - Note that tabular/statistical synthetic data is out of scope and point at SDV, since that is where a lot of search traffic lands. - Add a "Start here" path for newcomers, using entries already listed. - Merge "Important techniques" and "Examples in this repository" into a single "Techniques" section for runnable in-repo material. - Add "Related lists". Every existing entry is preserved verbatim. No links added or removed apart from the SDV pointer and the one related list. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ETY2hvBSr39C6veXShN2pi
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
1 participant
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.
First of a planned series. This one is purely structural — every existing entry is preserved verbatim, no links added or removed apart from an SDV pointer and one related list.
Why
The
Datasets,LibrariesandPaperssections were nested as###under## Important techniques, so they rendered as sub-parts of it instead of top-level sections. That's the main fix.While in there, the editorial policy was stated twice — once inside the Libraries section, once inside Papers — so it only applied where it happened to be written. It's now hoisted to the top as the list's contract.
Changes
Resources→Scope and inclusion criteria, with the policy pulled up and made explicit per resource type.synthetic-data-generationtopic is dominated by that world, so readers land here by mistake.Start heresection: a 5-step path for newcomers, built entirely from entries already in the list.Important techniques+Examples in this repositorymerged into oneTechniquessection for runnable in-repo material.###→##.Related listssection.Deliberately not in this PR
Follow-ups this surfaced
Start herestep 3 offers "distilabel or NeMo Data Designer" — worth revisiting.🤖 Generated with Claude Code
https://claude.ai/code/session_01ETY2hvBSr39C6veXShN2pi