Documentation: introduce hardware platforms documentation #2818
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This is initial groundwork for #2409. It introduces "Supported Platforms" top-level section, which aims to document architectures, SoCs and boards, following an organization similar to that of boards/ directory. Only few stub architectures/SoC currently added so that we can do this incrementally. This PR also includes board documentation for nrf52832-mdk board.
My intention is to move as much board documentation here as possible and only have a README for things not worth exposing in documentation (maybe in the end, we decide to fully use the docs and the READMEs are not used). Moreover, the aim is to start documenting aspects that actually apply to a whole SoC, which are usually mentioned in board READMEs repetitively.
After this we can iterate on the structure for each document and try to keep documents consistent. Maybe we can add a sort of skeleton or template for each level so that we can ensure this.
Impact
Documentation
Testing
Built docs locally