_pkgdown.yml

url: https://starburst.ing
template:
  bootstrap: 5
  bootswatch: cosmo
  bslib:
    primary: "#0066cc"

home:
  title: "staRburst • Seamless AWS Cloud Bursting for R"
  description: >
    Scale R to 100+ AWS workers with one line. Zero infrastructure management,
    automatic environment sync, and transparent cost tracking.

navbar:
  structure:
    left: [intro, reference, articles, examples, news]
    right: [search, github]
  components:
    home: ~
    intro:
      text: Get Started
      href: articles/getting-started.html
    reference:
      text: Reference
      href: reference/index.html
    articles:
      text: Examples
      menu:
      - text: "Getting Started"
        href: articles/getting-started.html
      - text: "---"
      - text: "Data Processing Examples"
      - text: "Monte Carlo Simulation"
        href: articles/example-monte-carlo.html
      - text: "Bulk API Calls"
        href: articles/example-api-calls.html
      - text: "Geospatial Analysis"
        href: articles/example-geospatial.html
      - text: "Model Grid Search"
        href: articles/example-grid-search.html
      - text: "---"
      - text: "Business Use Cases"
      - text: "Financial Risk Modeling"
        href: articles/example-risk-modeling.html
      - text: "ML Feature Engineering"
        href: articles/example-feature-engineering.html
      - text: "A/B Test Analysis"
        href: articles/example-bootstrap.html
      - text: "Report Generation"
        href: articles/example-reports.html
      - text: "---"
      - text: "Guides"
      - text: "Workload Shapes: When & How to Use It"
        href: articles/workload-shapes.html
      - text: "Performance & When to Use Cloud"
        href: articles/performance.html
    examples:
      text: Runnable Scripts
      href: https://github.com/scttfrdmn/starburst/tree/main/examples
    news:
      text: News
      href: news/index.html

# Grouped reference index. Only the user-facing exports are listed here, in the
# order a reader should discover them; the trailing internal/developer group keeps
# the future-backend S3 methods out of the way. Anything exported but not listed
# still appears under an auto-generated "undocumented"/other section, so this is
# additive, not a coverage risk.
reference:
- title: "Start here"
  desc: "Set up once, then run your first job."
  contents:
  - starburst-package
  - starburst_setup
  - starburst_is_configured
- title: "Core execution"
  desc: "Run work across AWS workers."
  contents:
  - starburst_map
  - starburst_cluster
- title: "future / furrr integration"
  desc: "Use staRburst as a future backend for existing future/furrr code."
  contents:
  - plan.starburst
  - starburst
- title: "Detached sessions"
  desc: "Long-running jobs that survive your R session closing."
  contents:
  - starburst_session
  - starburst_session_attach
  - starburst_list_sessions
- title: "Configuration"
  desc: "Account and backend defaults."
  contents:
  - starburst_config
  - starburst_status
- title: "Monitoring, logs & cost"
  contents:
  - starburst_logs
  - starburst_estimate
  - starburst_quota_status
  - starburst_check_quota_request
  - starburst_request_quota_increase
- title: "Infrastructure setup"
  desc: "One-time provisioning and maintenance."
  contents:
  - starburst_setup_ec2
  - starburst_rebuild_environment
  - starburst_cleanup_ecr
- title: "Developer & internal"
  desc: "Extension points and future-backend internals; not needed for normal use."
  contents:
  - StarburstBackend
  - StarburstFuture
  - future.starburst
  - launchFuture.StarburstBackend
  - listFutures.StarburstBackend
  - nbrOfWorkers.StarburstBackend
  - resolved.StarburstFuture
  - result.StarburstFuture
  - run.StarburstFuture
  - print.StarburstSessionStatus
  - session-api

articles:
- title: "Getting Started"
  navbar: ~
  contents:
  - getting-started
  - detached-sessions

- title: "Data Processing Examples"
  desc: "Parallel data processing use cases"
  contents:
  - example-monte-carlo
  - example-api-calls
  - example-geospatial
  - example-grid-search

- title: "Business Use Cases"
  desc: "Real-world business applications"
  contents:
  - example-risk-modeling
  - example-feature-engineering
  - example-bootstrap
  - example-reports

- title: "Guides"
  desc: "Performance, security, and operations"
  contents:
  - workload-shapes
  - performance
  - security
  - troubleshooting

footer:
  structure:
    left: developed_by
    right: built_with
  components:
    developed_by: |
      staRburst is developed by [Scott Friedman](https://github.com/scttfrdmn).

      Contact: [help@starburst.ing](mailto:help@starburst.ing)
    built_with: |
      Built with [pkgdown](https://pkgdown.r-lib.org/) and powered by
      [paws](https://paws-r.github.io/).