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

update and consolidate guides #337

Open
2 of 12 tasks
bertsky opened this issue Mar 17, 2023 · 2 comments
Open
2 of 12 tasks

update and consolidate guides #337

bertsky opened this issue Mar 17, 2023 · 2 comments
Assignees

Comments

@bertsky
Copy link
Collaborator

bertsky commented Mar 17, 2023

Besides addressing the currently open issues…

…we should try to improve the overall UX of the guides.

Ideas:

  • increase crossreferencing between guides where appropriate
  • rename Workflows by Workflow Guide in the TOC
  • add another top-level hierarchy for the TOC on the left (navigation bar) for the sister guides
  • link to Quiver from the Workflow Guide
  • link the Eval spec prominently, perhaps as a separate guide?
@lena-hinrichsen
Copy link
Member

lena-hinrichsen commented Mar 21, 2023

Here is a first draft on the Section User Guides & Info

How to OCR

Quick Start

The Quickstart guide includes:

  • An installation with Docker
  • setting up a workspace
  • an ocrd process command with a recommended workflow (as an alternative, I am thinking about using some default .nf file here and calling nextflow)
  • how to view the results
  • then a link to our GitHub Wiki and/or to the more detailed instruction and/or maybe the current workflow guide?

Setup

The more detailed instructions would basically be like in https://ocr-d.de/en/setup

Usage

OCR steps / OCR-D Processors

-the current Workflow Guide with a link to recommended workflows instead of having them at the buttom of the very long page

Recommended Workflows

cf. current Workflow Guide
maybe a link to Quiver?

Models

Glossary

Link to Github wiki/advanced tutorials

@lena-hinrichsen lena-hinrichsen self-assigned this Mar 28, 2023
@bertsky
Copy link
Collaborator Author

bertsky commented Dec 14, 2023

  • link to Quiver from the Workflow Guide

It seems Quiver is linked nowhere on the website (not even the sitemap). Should I open a separate issue for this @kba?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants