-
Notifications
You must be signed in to change notification settings - Fork 2
Suggest an order for the SciJava Ops docs #144
Copy link
Copy link
Closed
scijava/incubator
#98Labels
docsIssues relating to documentation of the Ops frameworkIssues relating to documentation of the Ops frameworkenhancement
Milestone
Description
The SciJava Ops documentation doesn't provide any strong indication which document should be visited first. I certainly agree that InstallingSciJavaOpsInFiji.md makes sense as the entry point, but what about after that? Should I go to OpBestPractices.md? SearchingForOps.md? In my experience when jumping around in those documents there were concepts I was not yet familiar with so I left those documents thinking I had stumbled into the advanced section. The best document for me after installing SciJava ops was CallingOps.md and ScriptingInImageJ2.md which broke down the bits I needed to get going.
Adding a TOC (maybe as a README?) or applying numbers to the docs might help here.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
docsIssues relating to documentation of the Ops frameworkIssues relating to documentation of the Ops frameworkenhancement