Repository status: invest, maintain or deprecate - accordproject/techdocs GitHub Wiki
The team also spent time reviewing the existing AP technology stack and repositories and discussed their maintenance status. The team concluded that we need more focus on a smaller set of core repositories, while peripheral repositories with low maintainer/contributor participation will be deprecated and moved to the archive status.
Repository | Function | Notes | Status |
---|---|---|---|
concerto | Data modelling and schema language | Core component for the whole stack. | Invest |
concerto-codegen | Code generation for Concerto data models | Widely used to convert data models to code. | Invest |
template-archive | In-memory representation of a template archive and ability to serialize to/from zip and directory structure | Needs to support JSON serialization of templates to support APAP use cases. | Invest |
template-engine | Merge engine that combines template mark plus data JSON to produce agreement mark JSON. | Invest | |
vscode-web-extension | VS Code Web Extension for Concerto | Needs to be updated to support Template Archives and Template Engine | Invest |
Portability / Platform Support | Dockerization of APAP server and CLIs. Research into supporting more languages. | Invest | |
Accord Project Agreement Protocol | REST API and Reference Implementation that wraps Template Archive and Engine | Need to build a functional reference implementation. | Invest |
Template Playground | Web-based environment to learn and experiment with templates etc. | Add support for template archives and trigger | Invest |
TemplateMark | Concerto data model for templates | Maintain | |
AgreementMark | Concerto data model for legal agreements | Maintain | |
Models Repo | https://models.accordproject.org | Move to APAP RI? | Maintain |
markdown-transform/markdown-transform | Data transformation API | Maintain | |
markdown-transform/markdown-template | Reading/writing templates to JSON and markdown | Maintain | |
markdown-transform/markdown-cicero | Reading/writing agreements to JSON and markdown | Maintain | |
markdown-transform/markdown-cli | Command line interface to run transformations | Maintain | |
markdown-transform/markdown-html | Reading/writing templates and agreements to HTML | Maintain | |
markdown-transform/markdown-it-cicero | Markdown-it plugin for agreements | Maintain | |
markdown-transform/markdown-it-template | Markdown-it plugin for templates | Maintain | |
markdown-transform/markdown-pdf | Reading/writing templates and agreements to PDF | Superseded by tools like Docling | Deprecate |
markdown-transform/markdown-word | Reading/writing templates and agreements to Word/DOCX | Superseded by tools like Docling | Deprecate |
markdown-transform/markdown-slate | Reading/writing templates and agreements to Slate.js JSON | Not relevant given that Web Components is deprecated | Deprecate |
Template Studio | Old template web playground | Replaced by Template Playground | Deprecate |
Web Components | UI components to edit templates/agreements | Don’t have maintainer | Deprecate |
MS Word Plugin | Word add-in to add clauses to docx files | Don’t have maintainer | Deprecate |
Yeoman Gen | Yeoman templates to bootstrap templates | Move into the CLI? | Deprecate |
QLDB | Amazon QLDB implementation of template runtime | Don’t have maintainer | Deprecate |
Corda | Integration (model generation) for Corda blockchain | Don’t have maintainer | Deprecate |
Fabric | Chaincode to trigger template logic on chain and store state on blockchain | Don’t have maintainer | Deprecate |
Template Repository (old templates) | https://templates.accordproject.org | Move to APAP RI? | Deprecate |