Contributing to the documentation

[jsr-p]

Hi

thanks for the package (and method)!

I would like to contribute to the documentation (I think I found an error).
However, I cannot build the documentation locally and cannot find any guide on
how you have built it yourselves.
I have installed version 2.1.0 of pkgdown, cloned your repo and tried to
build it with pkgdown::build_site(), however I get some errors:

❯ Rscript -e 'pkgdown::build_site()'
── Installing package did into temporary library ─────────────────────────────────────
── Building pkgdown site for package did ───────────────────────────────────────
Reading from: /home/jsr-p/gh-repos/forks/did
Writing to: /home/jsr-p/gh-repos/forks/did/docs
── Sitrep ──────────────────────────────────────────────────────────────────────
✖ Bootstrap 3 is deprecated; please switch to Bootstrap 5.
ℹ Learn more at
  <https://www.tidyverse.org/blog/2021/12/pkgdown-2-0-0/#bootstrap-5>.
✖ URLs not ok.
  In _pkgdown.yml, url is missing.
  See details in `vignette(pkgdown::metadata)`.
✔ Favicons ok.
✔ Open graph metadata ok.
✔ Articles metadata ok.
✖ Reference metadata not ok.
  In _pkgdown.yml, 1 topic missing from index: "get_wide_data".
  Either use `@keywords internal` to drop from index, or
── Initialising site ───────────────────────────────────────────────────────────
── Building home ───────────────────────────────────────────────────────────────
^C
Execution halted
❯ git remote -v
Rscript -e 'pkgdown::build_site()'
origin  [email protected]:bcallaway11/did.git (fetch)
origin  [email protected]:bcallaway11/did.git (push)
── Installing package did into temporary library ─────────────────────────────────────
── Building pkgdown site for package did ───────────────────────────────────────
Reading from: /home/jsr-p/gh-repos/forks/did
Writing to: /home/jsr-p/gh-repos/forks/did/docs
── Sitrep ──────────────────────────────────────────────────────────────────────
✖ Bootstrap 3 is deprecated; please switch to Bootstrap 5.
ℹ Learn more at
  <https://www.tidyverse.org/blog/2021/12/pkgdown-2-0-0/#bootstrap-5>.
✖ URLs not ok.
  In _pkgdown.yml, url is missing.
  See details in `vignette(pkgdown::metadata)`.
✔ Favicons ok.
✔ Open graph metadata ok.
✔ Articles metadata ok.
✖ Reference metadata not ok.
  In _pkgdown.yml, 1 topic missing from index: "get_wide_data".
  Either use `@keywords internal` to drop from index, or
── Initialising site ───────────────────────────────────────────────────────────
── Building home ───────────────────────────────────────────────────────────────
Reading README.md
Writing `404.html`
── Building function reference ─────────────────────────────────────────────────
Error:
! in callr subprocess.
Caused by error in `build_reference_index(pkg)`:
! In _pkgdown.yml, 1 topic missing from index: "get_wide_data".
ℹ Either use `@keywords internal` to drop from index, or
---
Standard error:
── Building pkgdown site for package did ───────────────────────────────────────
Reading from: /home/jsr-p/gh-repos/forks/did
Writing to: /home/jsr-p/gh-repos/forks/did/docs
── Sitrep ──────────────────────────────────────────────────────────────────────
✖ Bootstrap 3 is deprecated; please switch to Bootstrap 5.
ℹ Learn more at
  <https://www.tidyverse.org/blog/2021/12/pkgdown-2-0-0/#bootstrap-5>.
✖ URLs not ok.
  In _pkgdown.yml, url is missing.
  See details in `vignette(pkgdown::metadata)`.
✔ Favicons ok.
✔ Open graph metadata ok.
✔ Articles metadata ok.
✖ Reference metadata not ok.
  In _pkgdown.yml, 1 topic missing from index: "get_wide_data".
  Either use `@keywords internal` to drop from index, or
── Initialising site ───────────────────────────────────────────────────────────
── Building home ───────────────────────────────────────────────────────────────
Reading README.md
Writing `404.html`
── Building function reference ─────────────────────────────────────────────────
---
Backtrace:
1. pkgdown::build_site()
2. pkgdown:::build_site_external(pkg = pkg, examples = examples, run_dont_run = run_dont_run,…
3. callr::r(function(..., cli_colors, hyperlinks, pkgdown_internet) { …
4. callr:::get_result(output = out, options)
5. callr:::throw(callr_remote_error(remerr, output), parent = fix_msg(remerr[[3]]))
---
Subprocess backtrace:
 1. pkgdown::build_site(...)
 2. pkgdown:::build_site_local(pkg = pkg, examples = examples, run_dont_run = run_dont_run, …
 3. pkgdown::build_reference(pkg, lazy = lazy, examples = examples, run_dont_run = run_dont_r…
 4. pkgdown::build_reference_index(pkg)
 5. pkgdown::render_page(pkg, "reference-index", data = data_reference_index(pkg), …
 6. pkgdown:::render_page_html(pkg, name = name, data = data, depth = depth)
 7. pkgdown:::modify_list(data_template(pkg, depth = depth), data)
 8. pkgdown:::data_reference_index(pkg)
 9. pkgdown:::check_missing_topics(rows, pkg, error_call = error_call)
10. pkgdown:::config_abort(pkg, c("{sum(missing)} topic{?s} missing from index: {.val {pkg$top…
11. cli::cli_abort(message, ..., call = call, .envir = .envir)
12. | rlang::abort(message, ..., call = call, use_cli_format = TRUE, …
13. | rlang:::signal_abort(cnd, .file)
14. | base::signalCondition(cnd)
15. global (function (e) …
Execution halted

Do you specify any flags when you build the docs or how do you do it?