Skip to content

Refactor documentation system #301

@cmungall

Description

@cmungall

The current doc system is described here URL: http://purl.obolibrary.org/obo/uberon/references/reference_0000000

Issues:

  • Not friendly to web-based editing of manual pages, design patterns etc
  • Editor must edit from within Protege, no native markdown support, no way to see formatted changes
  • Individual articles not versioned
  • numeric ordering by ID not necessarily the most intuitive
  • we end up re-inventing our own CMS

Suggested replacement:

  • use github wiki system
  • continue to use md as format
  • individual page per article
  • directory contents can still be slurped into owl for importation and linking within protege
  • can clone git@github.com:cmungall/uberon.wiki.git and edit md files just like a stanard git repo

Advantages:

  • multiple people can contribute by editing via github wiki
  • per-article versioning
  • can provide TOC easily
  • integrated with rest of project

Possible extensions:

  • automated job that replaces LABEL syntax with MD links to PURLs

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions