Change log#

Documentation Baseline (2024-Q4)#

New Documentation Structure: FairDM now provides comprehensive role-based documentation for all user types:

Getting Started Guide: Complete walkthrough from running the demo portal to defining custom models, registering them, and verifying via UI and API
Before You Begin: Prerequisites, tools, and setup requirements
Enhanced Developer Guide with clear role description and navigation

Managing Users and Permissions: Comprehensive guide to user management, pre-configured groups, and object-level permissions
Adjusting Dataset Access: Step-by-step scenarios for controlling dataset access and enabling public FAIR-compliant data
Enhanced Admin Guide with core entities overview and responsibilities

Getting Started as a Contributor: First contribution walkthrough covering login, dataset navigation, adding samples and measurements
Understanding Core Data Structures: Contributor-focused explanation of Projects, Datasets, Samples, and Measurements
Metadata Best Practices: Practical tips for FAIR-compliant metadata, controlled vocabularies, and provenance recording
Enhanced User Guide with FAIR principles explanation and contributor role clarity

Before You Start: Complete development environment setup instructions (fork, clone, install, migrate, test)
Python Code Development: Quality gates documentation covering tests, type checking, linting, and documentation builds with examples
Contributing to FairDM: Full contribution workflow from issue creation to pull request merge, with explicit constitution alignment guidance
Enhanced Contributing Guide with clear framework contributor role distinction

New users: Start with your role’s “Getting Started” guide for a guided first experience
Experienced users: Navigate directly to specific guides via the role-based structure
Evaluators: Review Getting Started first, then explore the constitution for principles
Contributors: All contribution types now have clear, independent workflows