search

Mbed-TLS / mbedtls-docs

Version-independent documentation for Mbed TLS
Apache License 2.0
21 stars 28 forks source link

Split the getting started guide into multiple pages #84

Closed davidhorstmann-arm closed 1 year ago

davidhorstmann-arm commented 1 year ago

The "Getting started" guide currently contains instructions for downloading and building Mbed TLS mixed in with PSA-related information. Split this guide into multiple pages that are easier to understand, putting them under a "Getting started" heading.

Note that the information in the "Getting started" page is not intended to be complete as of this PR, future work may improve it.

AndrzejKurek commented 1 year ago

What's the intended way to preview index.md? https://github.com/Mbed-TLS/mbedtls-docs/blob/46d7bdcf40014ae5cb57d7bb7a574d5fde23ffcd/getting_started/index.md gives a bad result.

gilles-peskine-arm commented 1 year ago

@AndrzejKurek CI check “docs/readthedocs.org:mbed-tls” → “Details” → “View docs” → navigate to the page that's changed