Technical Documentation

This section contains the technical documentation for Atlas Citations intended for developers.

Overview

Atlas Citations is a suite of TypeScript/Effect packages for querying bibliographic sources via typed clients, with OpenAPI specs validated against real APIs.

packages/
├── openapi-validator/  # OpenAPI validation tool
├── openalex/           # OpenAlex client
├── crossref/           # Crossref client
├── hal/                # HAL client
├── arxiv/              # ArXiv client
├── orcid/              # ORCID client
└── citations/          # Unified aggregator

Architecture

Document	Description
Architecture	Package structure and Effect patterns
Unified Schema	OpenAPI specification and entity mapping
Unified Client	Multi-source aggregation API

OpenAPI & Validation

Document	Description
OpenAPI Lifecycle	Versioning alpha -> beta -> stable
OpenAPI Validator	CLI spec validation tool
Rate Limiting	Quota management by source

Bibliographic Sources

Document	Description
Overview	Introduction to sources
Complete Catalog	All analyzed sources
Entity Reference	Entities by source
OpenAlex	OpenAlex client and spec
Crossref	Crossref client and spec
HAL	HAL client and spec
ArXiv	ArXiv client and spec
ORCID	ORCID client and spec
Versioning	Version management by source

Atlas Verify (Verification System)

Document	Description
Author Verification	Data model and workflows
Researcher Profile	Career/expertise reconstruction algorithms
Databases	PostgreSQL, MongoDB analysis, etc.
Advanced Databases	ArangoDB, vector search, multi-database federation

Technical Stack

Technology	Usage
TypeScript 5.x	Primary language
Effect	Effect and error management
openapi-typescript	Type generation from OpenAPI
Vitest	Unit tests
tsup	Package builds

Links to User Documentation

For documentation intended for researchers (end users), see:

• Atlas Verify User Guide - Documentation for researchers