Skip to content

Clarify architectural vision: TransformationSpecification as IR#153

Merged
amc-corey-cox merged 2 commits intomainfrom
docs-architecture-vision
Mar 10, 2026
Merged

Clarify architectural vision: TransformationSpecification as IR#153
amc-corey-cox merged 2 commits intomainfrom
docs-architecture-vision

Conversation

@amc-corey-cox
Copy link
Copy Markdown
Contributor

Summary

  • Sharpens the framing in docs and README to lead with the TransformationSpecification as the core value proposition — a declarative IR for data model mappings
  • Documents the two execution backends: Python ObjectTransformer (full support) and SQL/DuckDB (experimental, limited subset)
  • Clarifies that output serialization formats are intentionally text-based; loading into analytical stores is a downstream concern
  • Fixes "ployglot" typo, updates stale "forthcoming" references

Files changed

  • docs/index.md — new Architecture section, updated features list and Details section
  • README.md — updated opening framing and features list
  • docs/faq.md — added multi-backend framing paragraph

Related issues

Test plan

  • Verify mkdocs builds cleanly
  • Review wording for accuracy re: current SQL backend capabilities

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@amc-corey-cox amc-corey-cox requested a review from Copilot March 10, 2026 21:23
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the project documentation to frame TransformationSpecification as LinkML-Map’s declarative intermediate representation (IR), and to describe the current execution backends (Python vs experimental SQL/DuckDB) and output/serialization scope.

Changes:

  • Reframes docs/README opening to lead with TransformationSpecification as the core concept (IR).
  • Adds an Architecture section describing Python execution vs experimental SQL/DuckDB compilation.
  • Updates feature lists and fixes/refreshes some stale wording (e.g., “polyglot”, “forthcoming”).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
docs/index.md Adds Architecture section; updates features and CLI compile targets; clarifies polyglot framing and output scope.
docs/faq.md Adds a paragraph introducing the multi-backend / IR framing.
README.md Updates opening and feature list to reflect IR-first framing and experimental SQL backend.

Comment thread docs/index.md
Comment thread docs/faq.md
@amc-corey-cox amc-corey-cox merged commit 8c54507 into main Mar 10, 2026
15 checks passed
@amc-corey-cox amc-corey-cox deleted the docs-architecture-vision branch March 10, 2026 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants