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.
This pull request updates the documentation and metadata for the
primalbedtoolslibrary to reflect the latest file format (v3) and usage patterns, improves clarity and organization of the docs, and bumps the package version to1.0.0. The changes focus on making the documentation more beginner-friendly, aligning terminology, and removing outdated references.Documentation improvements:
docs/index.mdto provide a clearer quick start guide, a concise summary of the library, a history of the primer file formats, and examples for the latest v3 format. Added detailed explanations forBedLineobject fields and usage. [1] [2]docs/api.mdto use consistent capitalization and added a new section forScheme.BedfilesandPrimerPairsfromdocs/reference.md.mkdocs.ymlto use "Quick Start" instead of "primalbedtools" for the main index page.Versioning and terminology updates:
1.0.0inpyproject.tomlto mark the new release and major changes.docs/how-to-guides.mdto refer to the current primer name format as v3 instead of v2.