[all-commits] [llvm/llvm-project] 692c77: [libc][docs] reorder docs to be more beginner frie...

Nick Desaulniers via All-commits all-commits at lists.llvm.org
Tue Jan 14 09:38:38 PST 2025


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 692c77f2af133874f18942fe8c32f0f072bfc02b
      https://github.com/llvm/llvm-project/commit/692c77f2af133874f18942fe8c32f0f072bfc02b
  Author: Nick Desaulniers <nickdesaulniers at users.noreply.github.com>
  Date:   2025-01-14 (Tue, 14 Jan 2025)

  Changed paths:
    M libc/docs/build_and_test.rst
    R libc/docs/c23.rst
    R libc/docs/fullbuild_mode.rst
    A libc/docs/getting_started.rst
    M libc/docs/index.rst
    M libc/docs/porting.rst
    R libc/docs/usage_modes.rst

  Log Message:
  -----------
  [libc][docs] reorder docs to be more beginner friendly (#122376)

This commit does a few things, with the intent to make it more straightforward
to potential future users how to get started with llvm-libc. Answers to "What's
the status and how do I use it?" are front and center, "above the fold."

This commit does a few things:
* reorganize the landing page's toctree: start with implementation status, arch
* support, platform support, and
    compiler support.
  * Then a (new) simple getting started page using full host builds. Then more
  * Advanced topics such as host vs cross builds, overlay mode,
    gpu builds and additional configuration options.
* Remove c23 status, the old fullbuild_mode landing page, and
  usage_modes landing pages. c23 status isn't as interesting as I originally
  thought it might.

We should point people at full host builds to start, then link to more info on
cross compilation, or overlay mode as more advanced topics. I assert most users
starting out won't care about those.



To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications


More information about the All-commits mailing list