research-link-ai / docs /output-format.md
MHamdan's picture
Deploy Research-Link-AI (Docker Space, offline demo)
a753e74 verified
|
Raw
History Blame Contribute Delete
1.56 kB

Output Format: ResearchLink AI

Paper Module Directory

Every paper generates a YYYY-paper-slug/ directory:

YYYY-paper-slug/
  README.md               β€” Quick overview + links
  metadata.yml            β€” Structured YAML metadata
  paper-card.md           β€” One-page structured summary
  digest.md               β€” Plain-English deep dive
  literature-review.md    β€” Research landscape positioning
  concept-map.md          β€” Mermaid diagrams
  implementation-link.md  β€” Code repository guide
  reproducibility.md      β€” Reproduction guidance + checklist
  limitations.md          β€” Limitations and validity
  teaching-path.md        β€” Staged learning path
  references.md           β€” Reference list
  references.bib          β€” BibTeX entries
  generation-report.md    β€” Pipeline run summary
  notes/
    reviewer-style-summary.md
    claim-evidence-table.md
    related-work-matrix.md
  labs/
    README.md
    01-concept-toy-example.py
    02-method-toy-example.py
    03-reward-or-metric-example.py

Standard Header

Every .md file starts with:

> **Generated by ResearchLink AI.** Please review citations, metadata, and claims before publishing.

metadata.yml Fields

All fields listed in schemas/paper.py::PaperMetadata. Verification and confidence sections are always included.

Quality Flag Levels

  • ERROR: β€” Must be fixed before publishing (e.g., citation placeholders)
  • WARN: β€” Should be reviewed (e.g., missing venue)
  • INFO: β€” Informational (e.g., Semantic Scholar match found)