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

add documentation for new path tool #547

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

melonora
Copy link
Contributor

@melonora melonora commented Jan 9, 2025

References and relevant issues

#7099

Description

This PR adjust the documentation to include documentation for the new path tool. The old path tool is now called add polyline tool. Documentation has been adjusted to also reflect this.

@melonora melonora requested a review from melissawm January 9, 2025 11:02
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 9, 2025
@melonora melonora added this to the 0.5.6 milestone Jan 9, 2025
Copy link
Member

@psobolewskiPhD psobolewskiPhD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I made a few suggestions.

The "details" blocks look duplicated? maybe we should just have one?
I assume we could have a anchor to link to it from the lasso tool?

melonora and others added 6 commits January 10, 2025 13:35
Co-authored-by: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Co-authored-by: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Co-authored-by: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
@melonora
Copy link
Contributor Author

Looks good, I made a few suggestions.

The "details" blocks look duplicated? maybe we should just have one? I assume we could have a anchor to link to it from the lasso tool?

Thanks @psobolewskiPhD, I adjusted by adding a template markdown file in _templates that contains the section in the dropdown menu for both the lasso and path tool.

melonora and others added 2 commits January 10, 2025 15:20
Co-authored-by: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
Co-authored-by: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
@psobolewskiPhD
Copy link
Member

I think I still slightly lean towards one dropdown box explaining the details, since they are the same.
I think you can do

:::{dropdown} foo
:name: foo-bar

::::

and then link to the box using `[my text](#foo-bar)`

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.

2 participants