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.

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

SWDEV-427628 - Documentation restructure #3405

Closed
wants to merge 4 commits into from

Commits on Mar 11, 2024

  1. Reorganize documentation based on diátaxis

    As part of the diátaxis reorg, docs are being distributed to the 4 quadrants. Some of the existing content doesn't fit well into any of the quadrants and will require a rewrite. Until then, they will be exposed as legacy, to not remove content.
    MathiasMagnus committed Mar 11, 2024
    Configuration menu
    Copy the full SHA
    985a14c View commit details
    Browse the repository at this point in the history
  2. Convert initial batch of content from Markdown to Restructured Text

    In an attempt at better communicate to users that documentation is not meant to be consumed by browsing the code, the content is being ported to ReST. This also allows for better extensibility and removes the need for resorting to non-standard extensions (MyST).
    MathiasMagnus committed Mar 11, 2024
    Configuration menu
    Copy the full SHA
    1795047 View commit details
    Browse the repository at this point in the history

Commits on Mar 12, 2024

  1. Configuration menu
    Copy the full SHA
    96ac5d9 View commit details
    Browse the repository at this point in the history
  2. Offload math built-in documentation to llvm-project

    The array of built-in functions documented as standalone text proved to easily go out of sync with the compiler functionality. It was decided that it's best consumed
    MathiasMagnus committed Mar 12, 2024
    Configuration menu
    Copy the full SHA
    d4b4a5a View commit details
    Browse the repository at this point in the history