docs/zircon/_toc.yaml

# Please, read https://fuchsia.dev/fuchsia-src/best-practices/documentation_navigation_toc
# before making changes to this file, and add a member of the fuchsia.dev
# team as reviewer.
toc:
- title: "Overview"
  path: /docs/zircon

- title: "Getting started"
  path: /docs/zircon/getting_started.md

- title: "Building zircon"
  section:
  - include: /docs/zircon/gn/_toc.yaml

- title: "Architecture support"
  path: /docs/zircon/architecture_support.md

- title: "Concepts"
  path: /docs/zircon/concepts.md

- title: "Contributing patches"
  path: /docs/zircon/contributing.md

- title: "C++"
  section:
  - title: "Overview"
    path: /docs/zircon/cxx.md
  - title: "Compile time collections"
    path: /docs/zircon/compile_time_object_collections.md
  - title: "fit::promise<> guide"
    path: /docs/zircon/fit_promise_guide.md

- title: "Editors"
  path: /docs/zircon/editors.md

- title: "libc support"
  path: /docs/zircon/libc.md

- title: Objects
  section:
  - title: "Kernel objects"
    path: /docs/zircon/objects.md
  - include: /docs/zircon/objects/_toc.yaml
  - title: "Timer Slack"
    path: /docs/zircon/timer_slack.md
  - title: "Time units"
    path: /docs/zircon/time.md

- title: "Kernel"
  section:
  - title: "Kernel command line options"
    path: /docs/zircon/kernel_cmdline.md
  - title: "Kernel internal errors"
    path: /docs/zircon/kernel_internal_errors.md
  - title: "Kernel invariants"
    path: /docs/zircon/kernel_invariants.md
  - title: "Kernel scheduling"
    path: /docs/zircon/kernel_scheduling.md
  - title: "Fair scheduling"
    path: /docs/zircon/fair_scheduler.md
  - title: "Kernel tracing"
    path: /docs/zircon/tracing/ktrace.md

- title: "Errors"
  path: /docs/zircon/errors.md

- title: "Exceptions"
  path: /docs/zircon/exceptions.md

- title: "Handles"
  path: /docs/zircon/handles.md

- title: "Rights"
  path: /docs/zircon/rights.md

- title: "Signals"
  path: /docs/zircon/signals.md

- title: "Thread safety annotations"
  path:  /docs/zircon/thread_annotations.md

- title: "Thread local storage"
  path: /docs/zircon/tls.md

- title: "Runtime locks"
  section:
  - title: Overview
    path: /docs/zircon/lockdep.md
  - title: Design
    path: /docs/zircon/lockdep-design.md

- title: "System calls"
  section:
  - include: /docs/zircon/syscalls/_toc.yaml

- title: "abigen file grammar"
  path: /docs/zircon/abigen/grammar.md

- title: "Bootsvc"
  path: /docs/zircon/bootsvc.md

- title: "Userspace bootstrapping"
  path: /docs/zircon/userboot.md

- title: "Program loading"
  path: /docs/zircon/program_loading.md

- title: "Jitterentropy"
  section:
  - include: /docs/zircon/jitterentropy/_toc.yaml
- title: "Minfs"
  path: /docs/zircon/minfs.md

- title: "Zxcrypt"
  path: /docs/zircon/zxcrypt.md

- title: "Driver interfaces"
  section:
  - include: /docs/zircon/driver_interfaces/_toc.yaml

- title: "DDK"
  section:
  - include: /docs/zircon/ddk/_toc.yaml

- title: "Targets"
  section:
  - include: /docs/zircon/targets/_toc.yaml

- title: "Debugging"
  section:
  - include: /docs/zircon/debugging/_toc.yaml

- title: "Testing"
  section:
  - title: "Overview"
    path: /docs/zircon/testing.md
  - title: "Block device testing"
    path: /docs/zircon/block_device_testing.md
  - title: "Entropy quality tests"
    path:  /docs/zircon/entropy_quality_tests.md
  - title: "Fuzzing the FIDL host tools"
    path:  /docs/zircon/fuzzing_fidl.md
  - title: "NAND testing"
    path: /docs/zircon/nand_testing.md

- title: "Hacking notes"
  path: /docs/zircon/hacking.md

- title: "Memory usage analysis tools"
  path: /docs/zircon/memory.md

- title: "Out of memory system"
  path: /docs/zircon/oom.md

- title: "Safe stack"
  path: /docs/zircon/safestack.md

- title: "Shadow call stack"
  path: /docs/zircon/shadow_call_stack.md

- title: "Symbolizer markup format"
  path: /docs/zircon/symbolizer_markup.md

- title: "Zircon and LK"
  path: /docs/zircon/zx_and_lk.md

- title: "Benchmarks"
  section:
  - include: /docs/zircon/benchmarks/_toc.yaml

- title: "Notes"
  section:
  - title: "Entropy collection TODOs"
    path: /docs/zircon/entropy_collection_todos.md
  - title: "Avoiding a problem with the SYSRET"
    path: /docs/zircon/sysret_problem.md

- title: "QEMU"
  path: /docs/zircon/qemu.md