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

Better usage examples in the quickstart #142

Open
confluence opened this issue Nov 28, 2023 · 0 comments
Open

Better usage examples in the quickstart #142

confluence opened this issue Nov 28, 2023 · 0 comments
Assignees

Comments

@confluence
Copy link
Collaborator

confluence commented Nov 28, 2023

The quickstart guide in the docs should contain 1) examples of all the different session creation methods, and 2) some very basic examples of opening and interacting with images, changing properties, etc.. Currently the usage examples are very arbitrary, and picked by a non-astronomer (me) out of the available functionality. They should be replaced with more realistic examples of what a real user might want to do with the UI.

The quickstart is intended to be a very brief introduction to the software, so this should be a very small selection. This is separate from the more complete user guide which is also planned for the wrapper and the snippets UI.

This work should wait for the refactoring PR (#123) and the basic region support PR (#136) to be merged.

@kswang1029 kswang1029 added this to CARTA Dec 6, 2023
@kswang1029 kswang1029 moved this to Icebox in CARTA Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Icebox
Development

No branches or pull requests

2 participants