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 documentation #221

Closed
jcfr opened this issue Nov 22, 2022 · 1 comment · Fixed by #222
Closed

Update documentation #221

jcfr opened this issue Nov 22, 2022 · 1 comment · Fixed by #222
Assignees
Labels
Type: Docs Documentation related

Comments

@jcfr
Copy link
Collaborator

jcfr commented Nov 22, 2022

What's the problem this feature will solve?

Current page hosted at https://cell-locator.readthedocs.io does not clearly document:

  • Overview of the interface
  • Available command line modules

Describe the solution you'd like

Add the following sections

  • Update Getting Started section to include sections:

    • System Requirements
    • Installing Cell-locator
  • Move as a top-level section

    • Coordinate System
    • User Interface/LIMS Integration -> LIMS Integration
    • Consolidate content of Developer Guide / LIMS Integration with the new top-level LIMS Integration section
  • Update User Interface to include Application overview

  • Add Command-line Tools

Alternative Solutions

Additional context

@jcfr jcfr added the Type: Docs Documentation related label Nov 22, 2022
@allemangD allemangD linked a pull request Nov 23, 2022 that will close this issue
@jcfr
Copy link
Collaborator Author

jcfr commented Dec 1, 2022

The documentation illustrating the impact of the coordinate system updates associated with the first few releases of Cell Locator has been migrated to a wiki page.

See https://github.com/BICCN/cell-locator/wiki/Coordinate-System-Updates

@jcfr jcfr closed this as completed in #222 Dec 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Docs Documentation related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants