mirror of
https://github.com/mikecarper/MeshCore.git
synced 2026-10-20 22:01:58 +00:00
132 lines
4.0 KiB
YAML
132 lines
4.0 KiB
YAML
site_name: MeshCore Docs
|
|
site_url: !ENV [MKDOCS_SITE_URL, 'https://meshcore-dev.github.io/meshcore/']
|
|
site_description: Documentation for the open source MeshCore firmware
|
|
|
|
repo_name: !ENV [MKDOCS_REPO_NAME, 'meshcore-dev/meshcore']
|
|
repo_url: !ENV [MKDOCS_REPO_URL, 'https://github.com/meshcore-dev/meshcore/']
|
|
edit_uri: !ENV [MKDOCS_EDIT_URI, 'edit/main/docs/']
|
|
|
|
hooks:
|
|
- scripts/docs_partition_catalog.py
|
|
|
|
# Keep historical URLs for bookmarks while showing only the organized copies.
|
|
not_in_nav: |
|
|
/*_validation.md
|
|
/*_results.md
|
|
/*_audit.md
|
|
/*_investigation.md
|
|
/*_trial.md
|
|
/hardware_validation_checklist.md
|
|
/home_text_spacing.md
|
|
/mbedtls-tls-footprint.md
|
|
/nrf52_companion_storage_recovery.md
|
|
/nrf52-usb-ready-fix.md
|
|
/radio_receive_calibration.md
|
|
/spiffs_regular_file_reads.md
|
|
/usb_serial_backpressure.md
|
|
/v4_pixel5_font_trial.md
|
|
/releases/1.17.1.5-doc-audit.md
|
|
/releases/1.17.1.5.md
|
|
/releases/1.17.1.6.md
|
|
/releases/1.17.1.7.md
|
|
/companion_contact_cache.md
|
|
/esp32_memory_budget.md
|
|
/firmware_memory_budget.md
|
|
/hardware_validation_bluetooth_stealth_2026-09-07.md
|
|
/nrf52_bluetooth_debug.md
|
|
/rak3401_1.17.1.7_legacy24.md
|
|
/rak3401_mota_chain.md
|
|
/research/*.md
|
|
/test-results/*.md
|
|
/test-results/preview-1.17.1.8/*.md
|
|
/old-releases/*.md
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Firmware and tools:
|
|
- firmware_picker.md
|
|
- notifications.md
|
|
- preset_test.md
|
|
- filter_tool.md
|
|
- telemetry_decoder.md
|
|
- management_decoder.md
|
|
- Documentation:
|
|
- Getting started and features:
|
|
- faq.md
|
|
- role_feature_switches.md
|
|
- full_companion_features.md
|
|
- companion_radio_full.md
|
|
- full_companion_usb_switcher.md
|
|
- companion_offline_queue.md
|
|
- halo_keymind_settings.md
|
|
- Firmware updates and partitions:
|
|
- ota_user_guide.md
|
|
- ota_easy.md
|
|
- lora_ota_automation.md
|
|
- ota_nrf52_bootloader_update.md
|
|
- ota_nrf52_qspi.md
|
|
- ota_meshtower_v2_sdcard.md
|
|
- esp32_partition_catalog.md
|
|
- esp32_wifi_partition_migration.md
|
|
- heltec_v4_wifi_partition_migration.md
|
|
- host_cli_service.md
|
|
- Radio, networking, and power:
|
|
- radio_profiles.md
|
|
- carrier_wave.md
|
|
- espnow_bridge_setup.md
|
|
- WiFi.md
|
|
- flood_filtering.md
|
|
- gps_tracking.md
|
|
- nrf52_power_management.md
|
|
- CLI and protocol reference:
|
|
- cli_commands.md
|
|
- cli_build_matrix.md
|
|
- cli_command_availability.md
|
|
- terminal_chat_cli.md
|
|
- companion_protocol.md
|
|
- kiss_modem_protocol.md
|
|
- packet_format.md
|
|
- payloads.md
|
|
- ota_protocol.md
|
|
- management_reports.md
|
|
- stats_binary_frames.md
|
|
- number_allocations.md
|
|
- qr_codes.md
|
|
- docs.md
|
|
- Research: research/index.md
|
|
- Releases:
|
|
- Current release:
|
|
- 1.17.1.8 USA Cascade: releases/1.17.1.8.md
|
|
- Test Results: test-results/index.md
|
|
- Old Releases: old-releases/index.md
|
|
|
|
theme:
|
|
name: material
|
|
logo: _assets/meshcore.svg
|
|
features:
|
|
- content.action.edit
|
|
- content.code.copy
|
|
- search.highlight
|
|
- search.suggest
|
|
|
|
extra_css:
|
|
- _stylesheets/notification_builder.css
|
|
- https://unpkg.com/leaflet@1.9.4/dist/leaflet.css
|
|
- _stylesheets/extra.css
|
|
- _stylesheets/firmware_picker.css?v=20261001-feedback-1
|
|
- _stylesheets/telemetry_decoder.css
|
|
- _stylesheets/management_decoder.css
|
|
- _stylesheets/filter_tool.css
|
|
- _stylesheets/preset_test.css?v=20260923-2
|
|
- _stylesheets/esp32_partition_catalog.css?v=20261001-1
|
|
|
|
extra_javascript:
|
|
- _javascript/notification_builder.js?v=20260930-audio-start
|
|
- https://unpkg.com/leaflet@1.9.4/dist/leaflet.js
|
|
- _javascript/firmware_picker.js?v=20261001-feedback-1
|
|
- _javascript/telemetry_decoder.js
|
|
- _javascript/management_decoder.js
|
|
- _javascript/filter_tool.js?v=20261002-hashbytes-2plus
|
|
- _javascript/preset_test.js?v=20260923-2
|
|
- _javascript/esp32_partition_catalog.js?v=20261001-1
|