Skip to content

Make a proper dedicated top-level documentation site #799

@yashi

Description

@yashi

https://discord.com/channels/720317445772017664/733037524498382881/1356918374231445524

Key Discussion Points:

  • Documentation Separation:

    • Current State: West documentation is embedded as a subsection in docs.zephyrproject.org.
    • Proposed Change:
      • Move West docs to its own dedicated site.
      • Keep essential West tutorials (e.g., getting started with West) and core commands (build, flash, debug) within the Zephyr documentation, but lean on the standalone site for technical details, history, and non-Zephyr-specific content.
  • Implementation and Milestones:

    • Reference GitHub issue #799 for creating the dedicated documentation site.
    • Set the milestone for West v2.0.0 to group related documentation updates.
    • The timeline for West v2.0 depends on community contributions and available time, with no fixed schedule currently.
  • Additional Considerations:

    • Separation of Extensions:
      • Ensure that Zephyr-specific extensions and built-in command documentation remain in the Zephyr repository to preserve usability and context (e.g., “west manifests” examples based on Zephyr).
    • Supporting Non-Zephyr Use Cases:
      • Address GitHub issue #246 to better support scenarios where West is used outside of Zephyr (e.g., for TF-A, EDK2).
    • Potential Backwards Incompatible Change:
      • Consider a change in West 2.0 to stop automatically setting ZEPHYR_BASE in extension commands, allowing extensions to find Zephyr by name or path when needed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions