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.

Sign up for GitHub

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

Jump to bottom

docs: Improve website + group articles + tweaks to documentation #903

Merged
merged 7 commits into from
Mar 27, 2024
Merged

docs: Improve website + group articles + tweaks to documentation #903

merged 7 commits into from
Mar 27, 2024

Conversation

olivroy
Copy link
Contributor

@olivroy olivroy commented Feb 19, 2024 •
edited
Loading

Follow-up to #902

  • Improve function reference
  • fix typos + links
  • Correct cross-references based on the recent update
  • Use tidyverse style guideline for references to functions. Enables linking on the website
  • Move the raster to pkgdown/asset to allow users reproducing the example
  • Move intro vignette to an article (there are many links + a widget which may cause problems on CRAN.
  • Change headings to 1st and 2nd level when applicable.
  • Reorder vignettes on the website
  • Add leaflet.js copyright notice to the website
  • Add @keywords internal for functions that are not necessarily user-facing to tidy up reference index

TODO: eventually remove vignettes/articles/nc after successful build.

@olivroy olivroy changed the title Improve website Improve website + group articles + tweaks to documentation Mar 27, 2024
schloerke
schloerke reviewed Mar 27, 2024
View reviewed changes
Copy link
Contributor

@schloerke schloerke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So sorry I didn't comment this earlier 🤦

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
DESCRIPTION Outdated Show resolved Hide resolved
R/normalize.R Show resolved Hide resolved
R/plugin-graticule.R Outdated Show resolved Hide resolved
R/plugin-minimap.R Outdated Show resolved Hide resolved
R/plugin-simplegraticule.R Outdated Show resolved Hide resolved
vignettes/articles/choropleths.Rmd Show resolved Hide resolved
vignettes/articles/leaflet.Rmd Outdated Show resolved Hide resolved
@olivroy @schloerke
Apply suggestions from code review
934404c 
Co-authored-by: Barret Schloerke <barret@posit.co>
@schloerke
Copy link
Contributor

TODO: eventually remove vignettes/articles/nc after successful build.

If this is just for gh-pages, I'm happy to make an issue for a followup PR later. gh-pages isn't in the main branch, so it can have many copies of files

@schloerke
Copy link
Contributor

Sorry @olivroy , you'll have to run devtools::document() to get rid of the failing docs check.

@schloerke schloerke mentioned this pull request Mar 27, 2024
Closed
@schloerke schloerke changed the title Improve website + group articles + tweaks to documentation docs: Improve website + group articles + tweaks to documentation Mar 27, 2024
@schloerke schloerke mentioned this pull request Mar 27, 2024
Closed
@schloerke schloerke merged commit 4f9a2d8 into rstudio:main Mar 27, 2024
11 of 12 checks passed
@schloerke
Copy link
Contributor

⭐ Thank you @olivroy !! ⭐

@olivroy olivroy deleted the site-follow branch March 27, 2024 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@schloerke schloerke schloerke approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@olivroy @schloerke