Project documentation centralization

[keighrim]

An epic thread to track major project-level documentations and their issues.

• project website
  • address: https://clams.ai
  • engine: jekyll
  • theme: https://github.com/clamsproject/website-theme
• MMIF spec documentation
  • address: https://mmif.clams.ai
  • engine: jekyll
  • theme: https://github.com/clamsproject/website-theme
• mmif-python documentation
  • address: https://clams.ai/mmif-python
  • engine: sphinx
  • theme: readthedoc-sphinx
  • issues
    • API documentation is largely outdated mmif-python#215
• clams-python documentation
  • address: https://clams.ai/clams-python & https://sdk.clams.ai
  • engine: sphinx
  • theme: readthedoc-sphinx
  • issues
    • documentation is largely outdated clams-python#136
• app directory
  • address: https://apps.clams.ai
  • theme & engine: minimal mistake
  • issues
    • add proper jekyll config/theme  apps#42
    • home page improvement apps#59
    • document directory behaviors apps#34
• appb-as-dataset documentation (
  • address & theme & engine: ???
  • issues
    • add annotation dashboard via github.io page publication  aapb-annotations#17
• evaluation dashboard
  • address & theme & engine: ???
  • issues
    • add evaluation dashboard via github.io page publication  aapb-evaluations#8
• CLAMS developers' glossary
  • suggested in update readme with common app documentation  apps#21 (comment)
  • we need a common vocabulary for developer terms (e.g. CLAMS "app" instead of tool)

[keighrim]

While addressing clamsproject/mmif-python#338, I'm building a new website for the main project "homepage" that actually functions as a centrailized documentation hub across all SDK and specs. As we are still figuring out what's the best form for the web presence of data and evaluation reports, for now I'm not integrating them. I'm holding appdir as well for now, as we are developing the best way to integerate app "search" function maybe based on the "app patterns" we've been discussing a lot.