search

insightsengineering / teal

Exploratory Web Apps for Analyzing Clinical Trial Data
https://insightsengineering.github.io/teal/
Other
184 stars 39 forks source link

Add bookmarking information to vignettes #1185

Open chlebowa opened 8 months ago

chlebowa commented 8 months ago

Companion to https://github.com/insightsengineering/teal/pull/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

  2. Amend Creating Custom Modules vignette.

    • mention bookmarking requirements and attribute
    • link to bookmarking vignette

  3. Amend pkgdown. suggested:

    - title: Extending `teal`
navbar: Extending `teal`
contents:
- creating-custom-modules
- bookmarking-teal-applications
- adding-support-for-reporting
donyunardi commented 8 months ago

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 commented 8 months ago

I should be the one to write it.

donyunardi commented 8 months ago

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