Merge pull request #667 from lorenzwalthert/improve-docs

- Little doc improvement (#667).

Author: lorenzwalthert

R/ui-caching.R

@@ -26,7 +26,7 @@ cache_clear <- function(cache_name = NULL, ask = TRUE) {
 #' but output code. That means if you style code that already complies to a
 #' style guide and you have previously styled that code, it will be quicker.
 #' Code is cached by expression and the cache is shared across all APIs (e.g.
-#' `style_text()` and Addin.
+#' `style_text()` and Addin).
 #'
 #' @section Setup:
 #' styler by default uses caching via the `{R.cache}` package. You will be

_pkgdown.yml

@@ -9,13 +9,14 @@ reference:
   - style_dir
   - styler_addins
 - title: "Fine-tune styling"
-  desc: "Customize style guildes"
+  desc: "Customize style guides"
 - contents:
+  - tidyverse_style
+  - tidyverse_reindention
+  - tidyverse_math_token_spacing
   - create_style_guide
   - specify_math_token_spacing
   - specify_reindention
-  - tidyverse_reindention
-  - tidyverse_math_token_spacing
 - title: "Non-functional documentation"
   desc: "Explaining features"
   contents:
@@ -56,3 +57,17 @@ news:
     href: https://www.tidyverse.org/blog/2019/11/styler-1-2-0/
   - text: "Version 1.3.0"
     href: https://lorenzwalthert.netlify.com/post/styler-1-3-0/
+
+articles:
+- title: End-users
+  navbar: End-users
+  contents:
+  - introducing_styler
+  - detect-alignment
+
+- title: Developers
+  navbar: Developers
+  contents:
+  - caching
+  - customizing_styler
+  - performance_improvements

inst/WORDLIST

@@ -9,9 +9,12 @@ AST
 aut
 backport
 benchmarking
+bootswatch
 BugReports
 cancelling
+cff
 chnages
+ci
 cli
 CMD
 codecov
@@ -25,9 +28,11 @@ cran
 cre
 dec
 deps
+desc
 dev
 devtools
 dir
+docsearch
 dont
 dontrun
 dontshow
@@ -87,13 +92,16 @@ magrittr
 md
 Müller
 mutli
+navbar
+netlify
 NUM
 oldrel
 os
 ourself
 packagemanager
 packrat
 pandoc
+params
 parsable
 parsesum
 pgkdown
@@ -152,6 +160,7 @@ saveRDS
 seealso
 sep
 sessioninfo
+setCacheRootPath
 setdiff
 setenv
 sprintf
@@ -175,6 +184,7 @@ tidyeval
 tidyr
 tidyverse
 Tidyverse
+travis
 ubuntu
 ui
 uncached
@@ -192,6 +202,7 @@ walthert
 Walthert
 withr
 writeLines
+www
 xenial
 xfun
 Xie

man/caching.Rd

@@ -4,7 +4,7 @@ author: "Lorenz Walthert"
 date: "`r Sys.Date()`"
 output: rmarkdown::html_vignette
 vignette: >
-  %\VignetteIndexEntry{Vignette Title}
+  %\VignetteIndexEntry{Data Structures}
   %\VignetteEngine{knitr::rmarkdown}
   %\VignetteEncoding{UTF-8}
 ---