This vignette explains the structure of the generated content, the purpose of each of the generated site sections/pages and which assumptions pkgdocs makes.
Articles are generated from your package vignettes.
When initializing the documentation, pkgdocs will copy your vignettes in the folder docs/articles and render them with ?rmarkdown::render using a a special output format ?hugo_page. The output defined in your vignette front-matter is ignored since this is typically set to ?rmarkdown::html_vignette. The rationale behind this is to share a uniform style between the site and the vignettes.
You can learn more about this step in ?build_vignettes.
The reference section in your documention will be populated with a page for each topic documented in the .Rd files in your package man/ folder.
By default, no pages will be generated for topics that have been marked with \keyword{internal} When using roxygen, you can hide internal topics @keywords internal or @noRd to prevent the .Rd file from being generated.
If there is a source repository on GitHub for your package, pkgdocs will generate link configuration to keep track of the source of each page.
The source being linked depends on the content:
README.mdNEWS.md.Rd file or to the corresponding .R source file if the .Rd file was autogenerated (when using roxygen).If your DESCRIPTION file mentions a github repository it will be used to construct these links from. You can also pass it directly as an argument (github_repo) to ?build.