Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write A Lyric User Guide in Overture WIKI. #45

Open
Buwujiu opened this issue May 16, 2024 · 1 comment
Open

Write A Lyric User Guide in Overture WIKI. #45

Buwujiu opened this issue May 16, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Buwujiu
Copy link

Buwujiu commented May 16, 2024

Document Lyric in Overture WIKI.
https://wiki.oicr.on.ca/display/OV

What to include:

  • What is Lyric?
  • Define terms: Category, Organization. Explain the relationship of them.
  • How to register a dictionary in lectern?
  • How will users interact with Lyric API?
    • Steps to upload, submit, commit data
    • How to delete, update data
  • Draw a diagram of data submission flow
  • Mention key features such as: when new data is submitted, all data is validated against the latest dic.
  • PCGL should be registered as a Category,
@leoraba
Copy link
Contributor

leoraba commented May 28, 2024

Lyric home page: https://wiki.oicr.on.ca/display/OV/Lyric

@Buwujiu Buwujiu added the documentation Improvements or additions to documentation label Jun 20, 2024
@Buwujiu Buwujiu changed the title Document Lyric in Overture WIKI. Write A Lyric User Guide in Overture WIKI. Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants