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

Documentation v1 #146

Merged
merged 6 commits into from Nov 4, 2022
Merged

Documentation v1 #146

merged 6 commits into from Nov 4, 2022

Conversation

fedem-p
Copy link
Member

@fedem-p fedem-p commented Sep 28, 2022

I'm trying to write the first version for the documentation, this should act as a base that can be improved and modified along the way.

TODO:

  • Overview section
  • Developer guide
  • User Guide

@fedem-p fedem-p self-assigned this Sep 28, 2022
@fedem-p fedem-p added the documentation Improvements or additions to documentation label Sep 28, 2022
@coveralls
Copy link

coveralls commented Sep 28, 2022

Pull Request Test Coverage Report for Build 3396425029

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.07%) to 79.811%

Totals Coverage Status
Change from base Build 2744873404: 0.07%
Covered Lines: 2368
Relevant Lines: 2967

💛 - Coveralls

@fedem-p fedem-p marked this pull request as ready for review November 4, 2022 20:39
fedem-p and others added 6 commits November 4, 2022 21:46
setup overview section

setup developer guide

fixed logo image

set up hardware section

moved getting started guide

moved gettig started 2

hardware lint

underconstruction sections

update developer guide under construction sections

user guide under construction

removed possibility to change docs with PR

doc version 0.4

manual trigger

Added references and updated introduction

Updated sashimi structure

updated gui section for user

removed gui section in developer guide

udated calib, planar and volume mode

moved lightsheet procedure

added stytra links

moved procedure and added public usage example

updated hw interface section

updated  multiproc section

removed modes from devel

added scanning and hardware components

added images
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

Successfully merging this pull request may close these issues.

None yet

3 participants