Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(book): add an initial version of the support matrix #324

Merged
merged 13 commits into from
Jul 10, 2024
Merged

docs(book): add an initial version of the support matrix #324

merged 13 commits into from
Jul 10, 2024

Commits on Jul 10, 2024

  1. docs(book): add an initial version of the support matrix 

    Generate a support table from structured data. This table covers
hardware support as well as software/configuration support.
This structured data file is meant to later be validated/invalidated
based on the laze configuration, so that it always reflects the current
state of support.
    @ROMemories
    ROMemories committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    2d763e8 View commit details
    Browse the repository at this point in the history

  2. feat(support-matrix): support checking whether the output file is out… 

    …dated

This is useful in CI: developers are responsible for generating the HTML
file, but it can be checked in CI that that output file is up to date.
    @ROMemories
    ROMemories committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    8acb8cc View commit details
    Browse the repository at this point in the history

  3. ci(support-matrix): check that the HTML support matrix is up to date

    @ROMemories
    ROMemories committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    974f919 View commit details
    Browse the repository at this point in the history

  4. feat(support-matrix): improve some error messages

    @ROMemories
    ROMemories committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    99c4865 View commit details
    Browse the repository at this point in the history

  5. fix(support-matrix): validate support keys for boards and chips

    @ROMemories
    ROMemories committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    1d8e4dc View commit details
    Browse the repository at this point in the history

  6. docs(support-matrix): add some comments explaining the matrix's struc… 

    …ture
    @ROMemories
    ROMemories committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    e3c46a1 View commit details
    Browse the repository at this point in the history

  7. refactor(support-matrix): rename supports to support

    @ROMemories
    ROMemories committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    3fc51f5 View commit details
    Browse the repository at this point in the history

  8. fix(support-matrix): make the definition of support keys ordered 

    This is required so that we can control the order in which the keys are
shown in the HTML, and to be make sure the generation is deterministic.
    @ROMemories
    ROMemories committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    43ae68b View commit details
    Browse the repository at this point in the history

  9. fix(support-matrix): leverage support inheritance where possible

    @ROMemories
    ROMemories committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    66be237 View commit details
    Browse the repository at this point in the history

  10. feat(support-matrix): allow arbitrary URLs as links

    @ROMemories
    ROMemories committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    d71b8ac View commit details
    Browse the repository at this point in the history

  11. fix(support-matrix): use dl/dt/dd HTML elements for the table key

    @ROMemories
    ROMemories committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    f66c8dc View commit details
    Browse the repository at this point in the history

  12. feat(support-matrix): document STM32 support

    @ROMemories
    ROMemories committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    ccc6ca3 View commit details
    Browse the repository at this point in the history

  13. fix(support-matrix): fix output sorting

    @ROMemories
    ROMemories committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    79e354a View commit details
    Browse the repository at this point in the history