This file records where each Markdown file in this directory came
from. The originals remain in their respective source repositories and
are the canonical version there — this collection is a
consolidation copy intended for a central public documentation
site.
The following Markdown files exist in the source repositories but
were not pulled in, because they are not RaceLink-specific
documentation:
Third-party libraries under
RaceLink_Gateway/.pio/libdeps/** (RadioLib, U8g2 — their
README.md, contributing.md, SECURITY.md etc. belong to those
upstream projects).
PyPI cache and build artefacts under
RaceLink_RH_Plugin/.tmp/**, .venv/**, .tools/**, dist/**
(Flask, Werkzeug, idna, offline staging copies of the plugin).
Pytest cache (.pytest_cache/README.md in several repos).
Maintainer-local working notes — session logs and per-project
memo files held outside any of the four source repositories;
these are private to the maintainer's workstation and not
documentation.
The internal engineering ledger — a set of plan / design /
audit documents held outside the source repositories. It is
internal working material; its public-relevant content has been
folded into the appropriate documents in this consolidation.
The exclusion can be reproduced with:
# Inside each source repo:find.-name"*.md"-not-path"*/.pio/*"\-not-path"*/.venv/*"-not-path"*/.tmp/*"\-not-path"*/.tools/*"-not-path"*/dist/*"\-not-path"*/.pytest_cache/*"
When a source document changes, the copy here goes stale. Update
procedure:
Identify the changed document in the relevant source repository.
Copy the file from the source path to the consolidated path
listed above (e.g.
cp RaceLink_Host/docs/PROTOCOL.md RaceLink_Docs/docs/reference/wire-protocol.md).
Re-apply any consolidation fixes for that file. The git history
of this docs repo is the record of what was normalised last time
the file was synced from source.
For structural changes (new file, removed file, renamed path)
also update the file-by-file table here and the navigation in
index.md.
Source-code cross-references do not resolve. Many of the
original documents reference source files relatively (e.g.
../racelink/services/foo.py). This consolidation contains no
source code — those links work only inside the source repository.
For source-code references, see the matching source repository.
Cross-repo workstation paths do not resolve. For example,
RaceLink_Host/developer-guide.md originally referenced
../../WLED LoRa/WLED/...; those paths are workstation-specific
and not part of this set. Where they were essential, the
references have been replaced with text references to the upstream
WLED source layout (wled00/wled_server.cpp, etc.).
Markdown-to-Markdown links inside the same sub-project still
work (e.g. RaceLink_Host/operator-guide.md → reference/wire-protocol.md),
because the original directory structure is preserved per-repo.
The source repository remains the source of truth. When a
copy here and the source disagree, the source wins.