_pkgdown.yml

reference:
  - title: "vcr"
    desc: >
      High level overview of package
    contents:
      - vcr
      - vcr-package
  - title: "Configuration"
    desc: >
      Use use_vcr to get started
    contents:
      - use_vcr
      - starts_with("vcr_config")
  - title: "Main functions"
    desc: >
      Probably the only functions you'll need
    contents:
      - use_cassette
      - insert_cassette
      - eject_cassette
  - title: "Recording and matching"
    desc: >
      Details on recording and request matching options
    contents:
      - recording
      - request-matching
  - title: "vcr in tests"
    desc: >
      Functions for more custom workflows
    contents:
      - skip_if_vcr_off
      - vcr_test_path
  - title: "Check current recording state"
    contents:
      - real_http_connections_allowed
  - title: "Enable/Disable vcr"
    contents:
      - turn_off
      - turn_on
      - turned_off
      - turned_on
  - title: "Managing cassettes"
    contents:
      - as.cassette
      - as.cassettepath
      - cassette_path
      - cassettes
      - current_cassette
      - check_cassette_names
      - http_interactions
  - title: "Internals"
    desc: >
      You shouldn't need to use these directly
    contents:
      - Cassette
      - HTTPInteraction
      - HTTPInteractionList
      - Persisters
      - Request
      - RequestHandler
      - RequestHandlerCrul
      - RequestHandlerHttr
      - RequestHandlerHttr2
      - RequestMatcherRegistry
      - Serializers
      - serializer_fetch
      - UnhandledHTTPRequestError
      - VcrResponse
      - request_summary
      - response_summary
      - vcr_log_file
      - vcr_log_info
      - crul_request
      - str_splitter

articles:
- title: All vignettes
  desc: ~
  contents:
  - '`vcr`'
  - '`cassette-manual-editing`'
  - '`configuration`'
  - '`request_matching`'
  - '`debugging`'
  - '`write-to-disk`'
  - '`record-modes`'
  - '`lightswitch`'
  - '`internals`'
  - '`design`'