Using This Documentation

This documentation follows a hierarchical structure to help you navigate the 5G-MAG ecosystem efficiently. The main topics are located in the sidebar to the left, with specific subcategories available under each section.

Each main topic shares a consistent set of subcategories covering specifications, related projects, repository links, usage instructions, and hands-on tutorials.

Subcategories

Scope

The Scope section outlines the high-level architecture and objectives of each project. Here, you will find:

Links to relevant industry specifications and standards.
Architectural diagrams illustrating the implementation.
A feature matrix mapping specifications to their current implementation status.
Guidance for identifying which technical standards to study for a deeper understanding.

Roadmap

The Roadmap section connects you to our GitHub project boards. While major features are tracked via the “5G-MAG Reference Tools Roadmaps” board, developers may also use sub-project boards to monitor granular progress.

Repositories

The Repositories section provides direct links to the relevant GitHub codebases. Each repository includes its own build and installation instructions, as well as links to official releases and issue trackers.

Packages

When available, the Packages section provides pre-built binaries, containers, and Docker deployments. These resources are designed to accelerate the onboarding process for new users and contributors.

Tutorials

The Tutorials section offers end-to-end setup guides. These walkthroughs typically demonstrate how to integrate multiple components to create a functional system. While some tutorials focus on single components, others provide cross-references to related technical topics.

Suggested Workflow

To get the most out of this documentation, we recommend the following approach:

Explore the Architecture: Start with the Scope subcategory to understand the high-level design of your chosen technology.
Assess Status: Visit the Roadmap section to see what is currently implemented and what is planned for future releases.
Access the Code: Navigate to the Repositories subcategory to clone or download the software.
Implementation: Follow the Tutorials and check how to begin your local setup and testing.

Feedback & Support

We encourage all users to consult this documentation thoroughly before reaching out to maintainers. If your questions remain unanswered, we are happy to assist through our community channels:

GitHub: For bug reports and feature requests.
Slack: For real-time community discussion.
Public Monthly Call: Join our monthly sync to stay updated.