insightsengineering / insightsengineering/teal

Add bookmarking information to vignettes

Open
#1,185 3 comments 0 reactions 0 assignees View on GitHub
core documentation
Dominant language
R
Stars
263
Forks
59
Avg merge
5d 17h
Merged PRs (30d)
5

Description

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](https://github.com/insightsengineering/coredev-tasks/issues/520) and [this PR](https://github.com/insightsengineering/teal/pull/1011) 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
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.