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

API and developer documentation #15

Open
Connor-Bowley opened this issue Feb 10, 2022 · 0 comments
Open

API and developer documentation #15

Connor-Bowley opened this issue Feb 10, 2022 · 0 comments

Comments

@Connor-Bowley
Copy link
Contributor

I suggest to add the following markdown documents and reference them from the top-level README.md:

Docs/user_guide/modules/pipelinecreator.md
Docs/user_guide/modules/pipelinecaseiterator.md
Docs/developer_guide/modules/pipelinemodules.md
Docs/developer_guide/modules/pipelineclibridge.md

For pipelinecreator.md and pipelinecaseiterator.md, consider looking at examples in https://github.com/Slicer/Slicer/blob/master/Docs/user_guide/modules/, for example endoscopy.md

Indeed, I expect the UI will have minor changes.

For pipelinemodules.md and pipelineclibridge.md, you can look at examples at https://github.com/Slicer/Slicer/tree/master/Docs/developer_guide/modules. For these ones, I will keep things brief with a high level sentence and few links to relevant classes.

Example of content for pipelinemodules.md

# PipelineModules

This module is intended to provide the API for implementing module wrappers and registering them with the `PipelineCreator` module.

## Type of wrappers

[...]

Why this documentation structures ?

This is motivated by Slicer/Slicer#6090

Originally posted by @jcfr in #14 (comment)

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

1 participant