Historical documentation and version migration¶
Legacy HAL/OSAL/Kconfig pages describe old directories, interfaces, instance generation and ownership. They cannot govern current typed factories, static instances or borrowing lifetimes. This page gives old URLs an explicit version boundary; it never silently interprets old function names as current public APIs.
Continue with the current platform¶
Legacy content |
Current entry |
Must recheck |
|---|---|---|
HAL factory/device interfaces |
Generated IDs, readonly faces, cold lookup and platform lifecycle |
|
OSAL |
Backend differences, static storage, deadlines, publishers and join |
|
Kconfig platform/peripheral/OS macros |
One authored TOML, immutable IR, rejection rules and exact mode |
|
Old build/flash tutorials |
Actual tool versions, Board, SDK and artifact identities |
|
Historical software counts or pass records |
Original source, scope and receipts; documentation updates inherit no qualification |
Migration changes configuration, interface access, storage ownership and shutdown together, then revalidates the migrated source and assembly. Old parameters, object IDs and neighboring configuration results do not transfer to a new bundle.
Obtain frozen historical material¶
docs/archive/sphinx-before-next-generation/ and docs/archive/implementation/ preserve historical source and original numbering. They stay outside current default site search and establish no current capability or qualification. Select a specific Git commit to browse or download old source:
Legacy Sphinx source: frozen documentation planning baseline 0111c8d3
Historical RF implementation source: the same frozen baseline
This fixed revision identifies historical bytes only; it does not grant historical firmware qualification to that revision. Old locale PO files are historical translations, not reviewed current translations selected automatically by the language selector. For offline historical reading, obtain the fixed Git snapshot above. The current documentation package provides migration explanations and legacy URL aliases without adding every historical tutorial to current search or reinterpreting its contract.
How old addresses are handled¶
The URL migration table lists legacy RST paths, languages and target pages. Old en/ and zh_CN/ addresses remain separate. Public site root api/index.html is a historical API boundary entry directing readers to confirm the version before choosing migration guidance; it cannot silently mean the current API. Current public APIs live within an immutable version at the site-relative path versions/<release_id>/api/index.html, or at api/index.html under an extracted offline package root. Always identify the enclosing version root when interpreting an address. Legacy HAL/OSAL/Kconfig paths with different semantics enter this page to establish their version boundary before migration. Equivalent entries from the preceding simplified Sphinx site can enter corresponding current pages. Aliases are local HTML with relative links, without JavaScript, CDN or external redirection services.
The page migration and authority map records source pages, authority, reader tasks, actual site destinations and retention rules. Preserve original contract and result paths, linking originals or derived views rather than creating a second status or specification authority. Subsequent path changes update mappings, navigation, aliases and offline checks together.