How ur-whitelab/llms-in-science works
Project Type and Purpose
• This repository is a modular, content-oriented “documentation monorepo” for a review paper on large language models (LLMs) and autonomous agents in chemistry.
• It aggregates five submodules (Agents, LLM, Sci_LLM, Sci_agents, LLMTimeline) plus an assets folder and core README/CONTRIBUTING instructions.
• Contributors add, update, and categorize literature under these topical modules; readers browse structured markdown pages.
File Structure Analysis
• Top-level:
• .gitmodules – defines four Git submodules (Agents, LLM, Sci_LLM, Sci_agents)
• README.md – overview and TOC linking into submodule READMEs
• CONTRIBUTING.md – guidelines for community contributions
• LLMTimeline – likely holds a generated timeline image or code to produce it
• Each submodule has its own README.md, subdividing content by topic (e.g., memory, planning, tools in Agents).
• No application code or build scripts: it’s purely markdown content managed via Git.
a. Main Components
• Monorepo Root (Git repository)
• Submodule Modules (Agents, LLM, Sci_LLM, Sci_agents)
• Shared Assets folder
• CONTRIBUTING and Governance docs
• External Services: GitHub hosting, GitHub Pages (optional for site rendering), arXiv badge service
• Contributors (Users/Authors)
• Readers/Viewers
b. Relationships and Interactions
– Contributors clone/fork monorepo → update module READMEs → commit to submodule or main repo → open Pull Request → GitHub CI (linting/spell-check) → merge → GitHub Pages deployment.
– Readers access rendered site via GitHub Pages → navigate root TOC → dive into submodule content → click assets (images, timeline).
– Submodules link back to root CONTRIBUTING.md for contribution guidelines.
– External badge services (shields.io, arXiv) dynamically fetch status to embed in README.
c. Architectural Patterns & Principles
– Modularity: each topic lives in its own submodule, enabling isolated updates.
– Single Source of Truth: root TOC unifies navigation.
– Git Submodule Pattern: keeps large content sections decoupled.
– Static-site friendly: markdown + GitHub Pages (no server runtime).
d. Key Technologies/Frameworks
• Git / Git Submodules
• Markdown for content
• GitHub (hosting, Pages, Issues, PRs)
• Shields.io & arXiv badge service
• (Optional) Static site generator: GitHub Pages Jekyll or MkDocs if configured
Detailed Elements to Capture
• Submodule links defined in .gitmodules
• Root TOC links to each module README
• CONTRIBUTING.md as the policy gate
• LLMTimeline image generation or storage
• assets directory as shared media resource
• External badge services and arXiv integration