Skip to content

Conversation

@ChrisgKent
Copy link
Owner

This pull request updates the documentation and metadata for the primalbedtools library to reflect the latest file format (v3) and usage patterns, improves clarity and organization of the docs, and bumps the package version to 1.0.0. The changes focus on making the documentation more beginner-friendly, aligning terminology, and removing outdated references.

Documentation improvements:

  • Updated docs/index.md to 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 for BedLine object fields and usage. [1] [2]
  • Changed headings and table of contents labels in docs/api.md to use consistent capitalization and added a new section for Scheme.
  • Removed outdated documentation sections for Bedfiles and PrimerPairs from docs/reference.md.
  • Updated navigation in mkdocs.yml to use "Quick Start" instead of "primalbedtools" for the main index page.

Versioning and terminology updates:

  • Bumped the package version to 1.0.0 in pyproject.toml to mark the new release and major changes.
  • Updated terminology in docs/how-to-guides.md to refer to the current primer name format as v3 instead of v2.

ChrisKent added 2 commits September 4, 2025 12:31
@ChrisgKent ChrisgKent merged commit a45c656 into main Sep 4, 2025
10 checks passed
@ChrisgKent ChrisgKent deleted the 1.0.0 branch September 4, 2025 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants