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

docs: Increase discoverability of functions and articles #849

Merged
merged 26 commits into from
Oct 20, 2023

Conversation

gadenbuie
Copy link
Member

@gadenbuie gadenbuie commented Oct 18, 2023

  • Bring the @family tag to more places.
  • More @seealso in more places.
  • @seealso follow the style of complete sentences, typically X {verb} {description}. E.g. [card()] creates a card component. is used in the ?card_body docs.
  • @family Components is applied to the primary component function, e.g. card(), but not the secondary functions, e.g. card_body(). In the docs it will read Other components: card(), ... and these secondary functions reduce legibility.
  • In @references I'm trying to link to all relevant articles on the bslib website for each component.
  • Prefer rlang::is_interactive() over interactive() in examples, and try to use @examplesIf rlang::is_interactive() as much as possible.

@gadenbuie gadenbuie requested a review from cpsievert October 19, 2023 15:05
@gadenbuie gadenbuie marked this pull request as ready for review October 19, 2023 15:05
@gadenbuie gadenbuie self-assigned this Oct 19, 2023
gadenbuie and others added 2 commits October 19, 2023 16:03
Leaves `sidebar_toggle` as an alias but doesn't include it in the reference index or even show it in the `sidebar()` docs
R/accordion.R Outdated Show resolved Hide resolved
R/sidebar.R Outdated Show resolved Hide resolved
R/value-box.R Outdated Show resolved Hide resolved
@gadenbuie gadenbuie merged commit ceb30e3 into main Oct 20, 2023
12 checks passed
@gadenbuie gadenbuie deleted the docs/add-family-tag branch October 20, 2023 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants