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 bookmarking information to vignettes #1185

Open
Tracked by #1011
chlebowa opened this issue Mar 26, 2024 · 3 comments
Open
Tracked by #1011

Add bookmarking information to vignettes #1185

chlebowa opened this issue Mar 26, 2024 · 3 comments
Labels
core documentation Improvements or additions to documentation

Comments

@chlebowa
Copy link
Contributor

chlebowa commented Mar 26, 2024

Companion to #1011

  1. Add new vignette that explains bookmarking.
  • explain that teal bookmarks teal and modules bookmark themselves
  • explain the teal_bookmarkable attribute of modules
  • use this issue and this PR as sources of content
  1. Amend Creating Custom Modules vignette.
  • mention bookmarking requirements and attribute
  • link to bookmarking vignette
  1. Amend pkgdown.
    suggested:
- title: Extending `teal`
  navbar: Extending `teal`
  contents:
    - creating-custom-modules
    - bookmarking-teal-applications
    - adding-support-for-reporting
@chlebowa chlebowa added documentation Improvements or additions to documentation core labels Mar 26, 2024
@donyunardi
Copy link
Contributor

Since we're not exposing the feature just yet, I think we can postpone the vignette until later.
Or is there any specific reason to introduce the vignette now?

@chlebowa
Copy link
Contributor Author

I should be the one to write it.

@donyunardi
Copy link
Contributor

Agree, we can write this for now and hide it from public until we're ready to expose it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants