Closed MattiSG closed 1 year ago
@Ndpnt I renamed “document type” to “terms type” everywhere except in code in 9049cd3628ef10cd2f78080668e63948cb7d2c32, please let me know if you'd prefer that we delay this and have a single changeset with codebase, CLI, API and documentation as part of implementing https://github.com/ambanum/OpenTermsArchive/issues/964.
The README of this repository was initially created as a the first public presence of Open Terms Archive, before a website was even created. It contains a mix of political statements, user documentation and technical documentation, and is overall obsolete. Beyond outdated contents, the growth of the ecosystem, the maturity of the website and the architectural choices of moving slowly from a monolithic system to a more modular approach to keep the code maintainable, all mean that the documentation should now be focused on the technical aspects of the engine, and the user documentation kept separate.
This changeset:
docs
folder containing user documentation, that will be at some point moved to the recently createdOpenTermsArchive/docs
. This documentation is consolidated from different parts of this repository and other relevant repositories,If merged, the following subsequent actions should be taken:
Remove the documentation from
contrib-declarations
.Update links to the documentation in each collection README.
Co-authored with @Ndpnt.
Fixes https://github.com/ambanum/OpenTermsArchive/issues/811 https://github.com/ambanum/OpenTermsArchive/issues/963.
Relates to https://github.com/OpenTermsArchive/contrib-declarations/pull/696#issuecomment-1298347834
Depends on https://github.com/OpenTermsArchive/contrib-declarations/pull/746.