From 2064cdbf58d47e431ba2ef263081dbe483ed512a Mon Sep 17 00:00:00 2001 From: Rowan Cockett Date: Mon, 22 Dec 2025 21:18:01 -0700 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=97=BA=EF=B8=8F=20Initial=20roadmap?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- planning.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 planning.md diff --git a/planning.md b/planning.md new file mode 100644 index 0000000..7222892 --- /dev/null +++ b/planning.md @@ -0,0 +1,81 @@ +--- +title: Planning Document +--- + +This document outlines the strategic direction, milestones, and organizational structure for the OXA (Open Exchange Architecture) project. + +## Project Vision + +OXA aims to become the standard specification for representing scientific documents and their components as structured JSON objects, enabling seamless exchange, interoperability, and long-term preservation of scientific knowledge. + +## Strategic Goals + +1. **Schema Maturity**: Develop and stabilize core OXA schemas for common scientific document components +2. **Ecosystem Adoption**: Foster adoption across major authoring tools (Stencila, MyST, Quarto) and publishing systems +3. **Interoperability**: Enable conversion between OXA and other formats (JATS, Markdown variants, etc.) +4. **Community Growth**: Build a vibrant community of contributors, implementers, and users +5. **Standards Alignment**: Align with and contribute to relevant open science standards and initiatives + +## Current Focus Areas + +### Phase 1: Core Schema Development (Current) + +- **Setup Technical Infrastructure**: Build out the technical infrastructure +- **Setup RFC and Community Processes**: Build out the community infrastructure +- **Document Structure**: Core document, section, and paragraph schemas +- **Basic Content**: Text, emphasis, strong, links, and other inline elements +- **Metadata**: Authors, affiliations, funding, licenses +- **Math and Code**: Mathematical expressions and code blocks +- **Citations and References**: Mathematical expressions and code blocks +- **Figures and Media**: Panels, images, tables, and other media elements + +Goals: + +- Complete core schema development +- Release v0.1.0 of core schemas +- Release language-specific type packages +- Release initial CLI with documentation +- Publish initial specification documentation +- Begin RFC process +- Establish community meeting schedule + +### Phase 2: Extended Content Types (Planned) + +- **Executable Components**: Notebooks, interactive figures, reproducible code +- **Cross-references**: Citations, references, and document linking +- **Modular Documents**: Parts, components, and reusable elements +- **Versioning**: Document versioning and provenance tracking +- **Bundling/Container**: Container level information for complete research packages + +Goals: + +- Extended content type development +- Expand community engagement +- Develop conversion tools for major formats +- Begin tool integration discussions + +### Phase 3: Tool Integration (Planned) + +- **Converters**: Bidirectional conversion tools for major formats +- **Validators**: Schema validation tools and libraries +- **Publishers**: Publishing pipeline integration + +Goals: + +- Tool integration partnerships +- Repository integration partnerships +- Standards alignment activities +- Community growth initiatives + +## Review and Updates + +This planning document is a living document and should be reviewed and updated: + +- Quarterly by the Steering Council +- After major milestones or changes in direction +- Based on community feedback and evolving needs + +--- + +_Last updated: 2026-01-01_ +_Next review: 2025-03-01_ From 74f68d59060d195f41f260d53fa80210949353fc Mon Sep 17 00:00:00 2001 From: Rowan Cockett Date: Tue, 23 Dec 2025 04:21:47 +0000 Subject: [PATCH 2/2] Apply suggestions from code review --- planning.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/planning.md b/planning.md index 7222892..42269c5 100644 --- a/planning.md +++ b/planning.md @@ -1,5 +1,5 @@ --- -title: Planning Document +title: Roadmap & Planning --- This document outlines the strategic direction, milestones, and organizational structure for the OXA (Open Exchange Architecture) project. @@ -78,4 +78,4 @@ This planning document is a living document and should be reviewed and updated: --- _Last updated: 2026-01-01_ -_Next review: 2025-03-01_ +_Next review: 2026-03-01_