mkdocs.yml

site_name: Koinos One Documentation
site_description: User, operator, and developer documentation for Koinos One and Teleno Node.
repo_url: https://github.com/koinos/koinos-one
docs_dir: docs/manual
site_dir: build/docs/manual-site
strict: true
use_directory_urls: false
exclude_docs: |
  prompts/**

theme:
  name: readthedocs
  navigation_depth: 4

extra_css:
  - assets/koinos-one-mkdocs.css

markdown_extensions:
  - admonition
  - fenced_code
  - sane_lists
  - tables
  - toc:
      permalink: true

nav:
  - Home: README.md
  - Koinos Concepts:
      - Overview: concepts/README.md
      - What Is Koinos?: concepts/what-is-koinos.md
      - Accounts, Keys, And Wallets: concepts/accounts-keys-wallets.md
      - Transactions, Blocks, And Finality: concepts/transactions-blocks-finality.md
      - Observers, Producers, And Mainnet: concepts/observers-producers-and-mainnet.md
  - Koinos One User Guide:
      - Overview: koinos-one/README.md
      - Install On macOS: koinos-one/install-macos.md
      - First-Run Setup: koinos-one/first-run-setup.md
      - Node Dashboard: koinos-one/node-dashboard.md
      - Syncing A Node: koinos-one/syncing-a-node.md
      - Backup And Restore: koinos-one/backup-and-restore.md
      - Public Bootstrap Restore: koinos-one/public-bootstrap-restore.md
      - Wallet And Accounts: koinos-one/wallet-and-accounts.md
      - Producer Mode: koinos-one/producer-mode.md
      - Troubleshooting: koinos-one/troubleshooting.md
  - Teleno Node CLI Guide: teleno-node/README.md
  - Developer Documentation:
      - Overview: developers/README.md
      - Repository Tour: developers/repository-tour.md
      - Local Development: developers/local-development.md
      - Architecture Overview: developers/architecture-overview.md
      - GUI:
          - Overview: developers/gui/README.md
          - Electron, Vite, React Structure: developers/gui/electron-vite-react-structure.md
          - App State And Native Bridge: developers/gui/app-state-and-native-bridge.md
          - i18n And GUI Copy: developers/gui/i18n-and-gui-copy.md
          - Settings Screens: developers/gui/settings-screens.md
          - Packaging: developers/gui/packaging.md
      - Teleno Node:
          - Overview: developers/teleno-node/README.md
          - Source Layout: developers/teleno-node/source-layout.md
          - Component Overview: developers/teleno-node/component-overview.md
          - Chain, Block Store, And Mempool: developers/teleno-node/chain-block-store-mempool.md
          - P2P, JSON-RPC, And gRPC: developers/teleno-node/p2p-jsonrpc-grpc.md
          - Backup And Restore Internals: developers/teleno-node/backup-restore-internals.md
          - Storage And RocksDB: developers/teleno-node/storage-and-rocksdb.md
          - Testing And Validation: developers/teleno-node/testing-and-validation.md
          - Release Builds: developers/teleno-node/release-builds.md
      - Compatibility And Safety:
          - Koinos Protocol Boundary: developers/compatibility/koinos-protocol-boundary.md
          - Legacy Service Parity: developers/compatibility/legacy-service-parity.md
          - Mainnet Safety: developers/compatibility/mainnet-safety.md
      - Deeper References:
          - Koinos Protocol Compatibility Reference: developers/deeper-references/koinos-protocol.md
          - Current Monolithic Node Architecture: developers/deeper-references/monolith-architecture.md
          - Monolith Service Coverage: developers/deeper-references/monolith-service-coverage.md
  - Reference:
      - Overview: reference/README.md
      - Glossary: reference/glossary.md
      - Ports And Endpoints: reference/ports.md
      - Config Files And Data Directories: reference/config-files.md
      - Environment Variables: reference/environment-variables.md
      - Security Model: reference/security-model.md
      - Release Channels: reference/release-channels.md
      - Changelog: reference/changelog.md