_pkgdown.yml

url: https://scotgovanalysis.github.io/objr

development:
  mode: auto

template:
  bootstrap: 5
  bslib:
    base_font: {google: "Roboto"}

home:
  sidebar:
    structure: [links, license, community, citation, authors]

authors:
  Alice Hannah:
    html: "Alice Hannah  \
    <a href='mailto:alice.hannah@gov.scot'>\
    <i class='fas fa-envelope' aria-hidden='true'></i>\
    <span class='visually-hidden'>Email Alice Hannah></span></a>&nbsp;&nbsp;\
    <a href='https://github.com/alice-hannah'>\
    <i class='fab fa-github' aria-hidden='true'></i>\
    <span class='visually-hidden'>Alice Hannah GitHub profile></span></a>"
  Scottish Government:
    html: "Scottish Government&nbsp;&nbsp;\
    <a href='mailto:statistics.enquiries@gov.scot'>\
    <i class='fas fa-envelope' aria-hidden='true'></i>\
    <span class='visually-hidden'>Email Scottish Government></span></a>\
    &nbsp;&nbsp;\
    <a href='https://github.com/scotgovanalysis'>\
    <i class='fab fa-github' aria-hidden='true'></i>\
    <span class='visually-hidden'>Scottish Government GitHub profile></span>\
    </a>"
  sidebar:
    roles: [cre, aut]
  footer:
    roles: [cph]
    text: "Developed by the"

figures:
  dev: "svg"
  fig.ext: svg

reference:

- contents:
  - objr
  - my_user_id

- title: Workspaces
  desc: >
    Workspaces are the containers that connect a collection of documents and
    folders (Assets) with a collection of Users (Participants)
  contents:
  - workspaces
  - participants
  - add_participants

- title: Assets
  desc: Assets represent Documents and Folders that are added to Workspaces
  contents:
  - assets
  - asset_info
  - create_folder
  - rename_asset
  - delete_asset

- subtitle: Document versions
  contents:
  - versions
  - rollback_to_version

- subtitle: Download
  contents:
  - download_file
  - read_data

- subtitle: Upload
  contents:
  - upload_file
  - write_data

- title: Comments
  desc: View comments and create new threads and replies in workspaces
  contents:
  - comments
  - new_thread
  - new_reply

- title: Two-factor authentication
  desc: See `vignette("two-factor")` for more information.
  contents:
  - workgroup_bypass_2fa
  - participant_bypass_2fa

articles:
- title: Articles
  navbar: ~
  contents:
  - authentication
  - two-factor
  - faqs