openFPGALoader/mkdocs.yml at master · xsession/openFPGALoader · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
site_name: openFPGALoader
site_description: Universal utility for programming FPGAs
site_url: https://xsession.github.io/openFPGALoader/
repo_name: xsession/openFPGALoader
repo_url: https://github.com/xsession/openFPGALoader
edit_uri: edit/master/docs/
theme:
  name: material
  language: en
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - pymdownx.tasklist
  - tables
  - toc:
      permalink: true
plugins:
  - search
extra_javascript:
  - https://unpkg.com/mermaid@11/dist/mermaid.min.js
  - javascripts/mermaid.js
nav:
  - Home: index.md
  - Getting started:
      - Quick start: guide/quickstart.md
      - Installation: guide/install.md
      - Usage tutorial: guide/usage.md
      - Advanced usage: guide/advanced-usage.md
      - CLI reference: guide/cli-reference.md
      - Troubleshooting: guide/troubleshooting.md
  - How it works:
      - Overview: how-it-works/overview.md
      - JTAG transport: how-it-works/jtag-transport.md
      - Flash programming: how-it-works/flash-programming.md
      - SPI-over-JTAG bridges: how-it-works/spi-over-jtag.md
      - Direct SPI, DFU, and XVC: how-it-works/alternate-paths.md
  - Hardware:
      - Xilinx / AMD: hardware/xilinx.md
      - Lattice: hardware/lattice.md
      - Intel / Altera: hardware/intel-altera.md
      - Gowin: hardware/gowin.md
      - Efinix: hardware/efinix.md
      - Anlogic: hardware/anlogic.md
      - Cologne Chip: hardware/colognechip.md
      - XCF Platform Flash PROMs: hardware/xcf-platform-flash.md
  - Compatibility:
      - Boards: compatibility/boards.md
      - FPGAs: compatibility/fpgas.md
      - Cables: compatibility/cables.md
  - Field notes:
      - SPI-over-JTAG source review: debug/soj-review.md
      - SOJ v2 RDID alignment: debug/soj-v2-rdid-alignment.md
      - Xilinx Platform Cable USB:
          - Technical reproduction: debug/xpcu/technical-reproduction.md
          - Windows debug report: debug/xpcu/windows-debug-report.md
          - Windows setup: debug/xpcu/windows-setup.md
          - Cable driver deployment: debug/xpcu/cable-driver-deployment.md
          - Cable driver troubleshooting: debug/xpcu/cable-driver-troubleshooting.md
      - Spartan-6 XPCU SPI investigation: debug/spartan6-xpcu-spi-investigation.md
      - Spartan-6 HS3 M25P40 write stall: debug/spartan6-hs3-m25p40-write-stall.md
      - Digilent HS3 vs XPCU dump path: debug/digilent-hs3-vs-xpcu-dump-flash.md
      - MachXO3 recovery after bulk erase: debug/machxo3-recovery-after-bulk-erase.md
  - Development:
      - Architecture:
          - Overview: development/architecture/overview.md
          - Visual guide: development/architecture/visual-guide.md
          - Source map: development/architecture/source-map.md
          - Runtime flows: development/architecture/runtime-flows.md
          - Build and release: development/architecture/build-and-release.md
          - Decisions: development/architecture/decisions.md
          - C4 context: development/architecture/c4/context.md
          - C4 containers: development/architecture/c4/containers.md
          - C4 components: development/architecture/c4/components.md
          - C4 deployment: development/architecture/c4/deployment.md
      - Contributing: development/contributing.md
      - API reference: development/api-reference.md
      - Adding support:
          - FPGA, flash, and boards: development/adding-support/fpga-and-flash.md
          - SPI flash chips: development/adding-support/spi-flash-chips.md
          - SPI-over-JTAG bridges: development/adding-support/spi-over-jtag-bridges.md
      - CI:
          - Issues and fixes log: development/ci/issues-and-fixes.md
          - Build fixes (2026-10-01): development/ci/build-fixes-2026-10-01.md
          - Local Windows CI with act: development/ci/local-windows-ci-with-act.md
      - Deployment:
          - Overview: development/deployment/overview.md
          - Docker Linux deployment: development/deployment/docker-linux.md
          - Docker cross Windows build: development/deployment/docker-cross-windows.md
          - Windows driver packaging: development/deployment/windows-driver-packaging.md
  - Project:
      - Release notes: release-notes.md
      - Device support log: project/device-support-log.md
      - To do: project/todo.md