Skip to content

Polish README documentation and add repository map - #2

Merged
asthanaa merged 2 commits into
mainfrom
agent/polish-readme-citations
Aug 17, 2026
Merged

asthanaa merged 2 commits into
mainfrom
agent/polish-readme-citations

Conversation

@asthanaa

Copy link
Copy Markdown
Collaborator

What changed

  • Reworked the root README into a more polished project landing page.
  • Added an at-a-glance dataset summary for BenchmarkQC and corrected MolVQE-21.
  • Added a repository map covering source, datasets, docs, tests, and tooling.
  • Added clearer quick-start, validation, documentation, contributing, and license sections.
  • Removed the entire “Scientific scope and caveats” section.
  • Added BenchmarkQC and corrected MolVQE-21 citation links with BibTeX entries.

Validation

  • git diff --check passes.
  • Documentation-only change; no source code or dataset files were modified.

@asthanaa
asthanaa marked this pull request as ready for review August 17, 2026 00:03
@asthanaa
asthanaa merged commit be20d4a into main Aug 17, 2026
2 checks passed
@asthanaa
asthanaa deleted the agent/polish-readme-citations branch August 17, 2026 00:04
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.

1 participant