-
Notifications
You must be signed in to change notification settings - Fork 543
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
Add module overview documentation #6673
Conversation
Similarly to the section historically called I am wondering if this is the best place for this information. Should we instead keep that section descriptive n and only reference the extension wizard from developer_guide/extensions.html ? |
bc3d16d
to
29685a2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
I didn't read too closely, but that will be easier and the links can be checked once the docs are generated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Always nice to see traces of the old wiki removed in favor of the sphinx documentation. Agree that we can just do a final check that the links generally work once the documentation is built. Too lazy to build and check locally :)
Oh, nice I was looking for that; just need to "show all checks" Links seem to work 👍 |
This commit adds the documentation historically maintained on the Slicer wiki at https://www.slicer.org/wiki/Documentation/Nightly/Developers/Modules It revisits the "Specifications", "Getting Started" and "More information" sections based on content adapted from: * Slicer4_CLI.ppt slides presented at NA-MIC AHM 2012 and historically available at https://www.na-mic.org/wiki/AHM2012-Slicer-Overview-and-Migration#Module_Creation_and_Migration * SlicerProgramming.pptx available at https://github.com/PerkLab/PerkLabBootcamp It also removes links to obsolete trainings and simply references the training portal. Co-authored-by: Julien Finet <julien.finet@kitware.com> Co-authored-by: Steve Pieper <pieper@isomics.com> Co-authored-by: Andras Lasso <lasso@queensu.ca> Co-authored-by: Ebrahim Ebrahim <ebrahim.ebrahim@kitware.com>
This commit adds the documentation historically maintained on the Slicer wiki at https://www.slicer.org/wiki/Documentation/Nightly/Developers/Build_system/Remote_Module For reference, the page content was adapted from https://itk.org/Wiki/ITK/Policy_and_Procedures_for_Adding_Remote_Modules Co-authored-by: Steve Pieper <pieper@isomics.com>
29685a2
to
7a4ee2f
Compare
Thanks @ebrahimebrahim and @pieper for the review. This pull request has been updated to add the documentation historically maintained on the Slicer wiki at https://www.slicer.org/wiki/Documentation/Nightly/Developers/Modules It revisits the "Specifications", "Getting Started" and "More information" sections based on content adapted from:
It also removes links to obsolete trainings and simply references the training portal. |
The discussion also led to the creation of issue #6676 discussing proposal for improving the training portal. |
Module Overview
documentation (historically maintained on the Slicer wiki at https://www.slicer.org/wiki/Documentation/Nightly/Developers/Modules)Module Overview
documentation addingRemote Module
section (historically maintained on the Slicer wiki at https://www.slicer.org/wiki/Documentation/Nightly/Developers/Build_system/Remote_Module)