Fixes broken links by leveraging pkgdown autodetection of function use in inline code

[averissimo]

Changes description

• Change absolute paths to insightsengineering.github.io/teal/... to fun_name()
  • downside:
    • knitr keeps the inline code as is, so CRAN's vignettes don't have the links
  • upside:
    • pkgdown is smart to detect and create a link to the reference page (see within)
    • urlcheck CI doesn't fail on main and PRs with unreleased code
    • Articles in version-specific documentation don't suddenly take you to latest-tag

Alternatives considered

Using relative links (../reference), but this will break CRAN vignettes as well

[github-actions]

Code Coverage Summary

Filename                          Stmts    Miss  Cover    Missing
------------------------------  -------  ------  -------  ----------------------------------------------------------------------------------------------------------------------------------------
R/checkmate.R                        24       0  100.00%
R/dummy_functions.R                  67      11  83.58%   41, 43, 85-93
R/get_rcode_utils.R                  12       0  100.00%
R/include_css_js.R                   22      17  22.73%   12-38, 76-82
R/init.R                             99      42  57.58%   150-159, 161, 173-194, 219-222, 229-235, 238-239, 241
R/landing_popup_module.R             25      25  0.00%    61-87
R/module_bookmark_manager.R         158     127  19.62%   47-68, 88-138, 143-144, 156, 203, 238-315
R/module_data_summary.R             203      37  81.77%   26-54, 68, 78, 232, 263-267
R/module_filter_data.R               64       2  96.88%   22-23
R/module_filter_manager.R           230      57  75.22%   56-62, 73-82, 90-95, 108-112, 117-118, 291-314, 340, 367, 379, 386-387
R/module_init_data.R                 74       0  100.00%
R/module_nested_tabs.R              227      85  62.56%   40-136, 168, 193-195, 312, 346
R/module_snapshot_manager.R         216     146  32.41%   89-95, 104-113, 121-133, 152-153, 170-180, 184-199, 201-208, 215-230, 234-238, 240-246, 249-262, 265-273, 303-317, 320-331, 334-340, 354
R/module_teal_data.R                149      76  48.99%   44-150
R/module_teal_lockfile.R            131      44  66.41%   32-36, 44-56, 59-61, 75, 85-87, 99-101, 109-118, 121, 123, 125-126, 160-161
R/module_teal_with_splash.R          12      12  0.00%    22-38
R/module_teal.R                     195      87  55.38%   48-143, 158, 184-185, 224
R/module_transform_data.R           110       4  96.36%   20, 59, 129-130
R/modules.R                         278      71  74.46%   171-175, 230-233, 356-376, 384, 534-540, 553-561, 576-624, 657, 669-677
R/reporter_previewer_module.R        19       2  89.47%   30, 34
R/show_rcode_modal.R                 24      24  0.00%    17-42
R/tdata.R                            14      14  0.00%    19-61
R/teal_data_module-eval_code.R       24       0  100.00%
R/teal_data_module-within.R           7       0  100.00%
R/teal_data_module.R                 20       0  100.00%
R/teal_data_utils.R                  10       0  100.00%
R/teal_reporter.R                    68       6  91.18%   69, 77, 125-126, 129, 146
R/teal_slices-store.R                29       0  100.00%
R/teal_slices.R                      63       0  100.00%
R/teal_transform_module.R            45       0  100.00%
R/TealAppDriver.R                   353     353  0.00%    52-735
R/utils.R                           245      38  84.49%   391-440
R/validate_inputs.R                  32       0  100.00%
R/validations.R                      58      37  36.21%   110-377
R/zzz.R                              15      11  26.67%   4-18
TOTAL                              3322    1328  60.02%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: 4e6d738

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

  1 files   27 suites   10m 40s ⏱️
275 tests 257 ✅ 18 💤 0 ❌
501 runs  483 ✅ 18 💤 0 ❌

Results for commit 4e6d738.

♻️ This comment has been updated with latest results.

[github-actions]

Unit Test Performance Difference

Test Suite	$Status$	Time on main	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
module_teal	💔	$151.67$	$+2.68$	$0$	$0$	$0$	$0$
shinytest2-data_summary	💚	$54.06$	$-2.87$	$0$	$0$	$0$	$0$
shinytest2-decorators	💚	$23.55$	$-1.14$	$0$	$0$	$0$	$0$
shinytest2-filter_panel	💚	$44.19$	$-1.44$	$0$	$0$	$0$	$0$
shinytest2-init	💚	$28.41$	$-1.10$	$0$	$0$	$0$	$0$
shinytest2-landing_popup	💚	$47.56$	$-2.76$	$0$	$0$	$0$	$0$
shinytest2-module_bookmark_manager	💚	$37.26$	$-2.10$	$0$	$0$	$0$	$0$
shinytest2-modules	💚	$41.99$	$-3.31$	$0$	$0$	$0$	$0$
shinytest2-reporter	💚	$71.26$	$-3.49$	$0$	$0$	$0$	$0$
shinytest2-teal_data_module	💚	$51.30$	$-3.63$	$0$	$0$	$0$	$0$
shinytest2-teal_slices	💚	$63.53$	$-1.78$	$0$	$0$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
module_teal	💚	$18.95$	$-1.19$	creation_process_is_invoked_for_teal.lockfile.mode_enabled_and_snapshot_is_copied_to_teal_app.lock_and_removed_after_session_ended
shinytest2-modules	💚	$10.75$	$-1.07$	e2e_the_module_server_logic_is_only_triggered_when_the_teal_module_becomes_active
shinytest2-reporter	💚	$15.41$	$-1.71$	e2e_reporter_previewer_module_do_not_show_data_summary_nor_filter_panel
shinytest2-teal_slices	💚	$38.76$	$-1.15$	e2e_teal_slices_filters_are_initialized_when_module_specific_filters_are_created

Results for commit afa8e18

♻️ This comment has been updated with latest results.

[gogonzo]

Found out that https://rstudio.github.io/shiny/reference/moduleServer.html can be replaced with shiny::moduleServer(). Does it make sense to do this in this PR?

[averissimo]

Found out that https://rstudio.github.io/shiny/reference/moduleServer.html can be replaced with shiny::moduleServer(). Does it make sense to do this in this PR?

@gogonzo I noticed that too on the blueprint when searching for /references, I didn't want to replace it as the link makes sense in the text, I'm neutral on changing it, if so, maybe we could use something like:

-The `teal` framework leverages the [`shiny` module concept](https://rstudio.github.io/shiny/reference/moduleServer.html) to enable encapsulation of analytical actions in `teal` modules, while maintaining seamless communication between the modules and the application.
+The `teal` framework leverages the `shiny` module concept (`shiny::moduleServer()`) to enable encapsulation of analytical actions in `teal` modules, while maintaining seamless communication between the modules and the application.

[gogonzo]

👍 Please ignore my comment about moduleServer