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] switch vignettes from 'rmarkdown' to 'markdown' #228

Open
jameslamb opened this issue Jan 12, 2025 · 0 comments
Open

[docs] switch vignettes from 'rmarkdown' to 'markdown' #228

jameslamb opened this issue Jan 12, 2025 · 0 comments
Labels
maintenance miscellaneous maintenance R

Comments

@jameslamb
Copy link
Collaborator

Description

This project has one small vignette that doesn't rely on any special features of R markdown.

{uptasticsearch} should switch its rendering engine from {rmarkdown} to {markdown}, to reduce the number of dependencies that need to be installed to build the docs.

Benefits of this work

  • reduces the maintenance effort required to keep the package on CRAN
  • reduces the burden that {uptasticsearch} places on other projects and on CRAN
    • by removing {uptasticsearch} from more projects' reverse dependency lists

Acceptance criteria

  • {uptasticsearch}'s docs can be built without {rmarkdown}

Approach

See microsoft/LightGBM#6258

Notes

N/A

@jameslamb jameslamb added R maintenance miscellaneous maintenance labels Jan 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance miscellaneous maintenance R
Projects
None yet
Development

No branches or pull requests

1 participant