How sonic-net/sonic works
Purpose and Scope
This is SONiC’s coordination, documentation, and static-project-website repository—not the network OS implementation. It publishes architecture/design records, governance, release/project material, platform information, and source-repository links. The main site entry point is index.html; repository orientation and outbound source links are in README.md and sourcecode.md.
Static Website Surface
The root HTML pages form a static SONiC project site, sharing a navigation shell and bundled frontend assets. index.html is the landing page; menu.html provides site navigation; content pages include Supported-Devices-and-Platforms.html and sonic_latest_images.html. Styling and browser behavior are local static dependencies under assets/css/style.css, assets/js/custom.js, and assets/js/bootstrap.js.
Documentation Knowledge Base
doc/ is the architectural core: feature-oriented HLDs, design specifications, operational guides, and supporting diagrams. Each subdirectory is independently organized around a SONiC capability rather than executable modules. Representative system boundaries are configuration/database (doc/configuration/SONiC_NOS_Configuration_Methods.md, doc/database/multi_database_instances.md), management APIs (doc/mgmt/Management Framework.md, doc/mgmt/gnmi/SONiC_GNMI_Server_Interface_Design.md), and forwarding/platform design (doc/voq/architecture.md, doc/platform_api/new_platform_api.md).
SONiC Runtime Architecture References
The repository documents, but does not host, SONiC’s Linux-based and containerized runtime. Design documents describe control-plane services, database-mediated configuration/state, routing integration, and ASIC abstraction boundaries. Key references include doc/sonic-fpm-module/frr_sonic_communication_channel.md for FRR interaction, doc/multi_asic/DB_Design_for_multi_asic.md for multi-ASIC database topology, and doc/warm-reboot/SONiC_Warmboot.md for lifecycle continuity. External/runtime technologies materially referenced include Docker containers, Linux networking, Redis-style SONiC databases, FRR, gNMI/gNOI, and hardware ASIC/SAI ecosystems.
Content Navigation and Published Artifacts
The documentation table of contents is centralized in sonic_docs_toc.md; feature documents and linked assets are distributed under doc/ and images/. Historical/community-facing material is retained as root HTML, PDFs, and pdf/newsletters/. This creates a documentation publishing boundary: source Markdown/design assets are repository content, while rendering is primarily via GitHub/wiki and static pages rather than an application server.
Image and Platform Metadata Pipeline
Supported-platform and image-link pages are generated/maintained from repository metadata. sonic_image_links.json is the image-link data source, with generate_sonic_image_links.sh producing associated output. supported_devices_platforms_md.sh supports the platform-list publication flow. GitHub Actions automate these updates through .github/workflows/sonic_image_links_create_workflow.yml and .github/workflows/supported_devices_platforms_md.yml.
Governance and Contribution Control Plane
Project decision-making and contribution procedures live alongside technical material: governance.md, CONTRIBUTING.md, and tsc/. Maintainer and conformance processes are captured in tsc/repo-maintainer/SONiC_Repo_Maintainer.md and tsc/conformance/sonic_conformance_guideline.md. GitHub issue/PR templates and workflows provide the repository’s operational integration boundary under .github/.
Main entry points: menu.html Site navigation · sonic_image_links_create_workflow.yml GitHub Actions · Supported-Devices-and-Platforms.html Supported platforms page · sonic_latest_images.html Image links page
Components 21
Static project site
- Landing page
index.html - Site navigation
menu.html - Supported platforms page
Supported-Devices-and-Platforms.html - Image links page
sonic_latest_images.html - Frontend assets · Shared styling and browser behavior.
assets/css/style.css
Documentation knowledge base
- Documentation TOC · Central navigation for feature documentation.
sonic_docs_toc.md - Feature design documents · HLDs, specifications, operational guides, and diagrams organized by capability.
- Configuration and DB design
doc/configuration/SONiC_NOS_Configuration_Methods.md - Management API design
doc/mgmt/Management Framework.md - Forwarding and platform design
doc/voq/architecture.md - Runtime integration references · Covers FRR, multi-ASIC databases, and warm reboot.
doc/sonic-fpm-module/frr_sonic_communication_channel.md
Publication automation
- Image link metadata
sonic_image_links.json - Image link generator
generate_sonic_image_links.sh - Platform list generator
supported_devices_platforms_md.sh - GitHub Actions · Automates image-link and platform-list publication updates.
.github/workflows/sonic_image_links_create_workflow.yml
Governance and contribution
- Project governance
governance.md - Contribution process
CONTRIBUTING.md - Maintainer and conformance
tsc/repo-maintainer/SONiC_Repo_Maintainer.md
Referenced SONiC runtime
Documented external runtime; not implemented here.
- SONiC runtime ecosystem · Linux, containers, Redis-style databases, FRR, gNMI/gNOI, and ASIC/SAI.
Other components
- Repository orientation · Links readers to project resources and source repositories.
README.md - Source repository links
sourcecode.md
Connections 24
- Repository orientation → Source repository links: points to
- Landing page → Site navigation: uses navigation
- Landing page → Frontend assets: loads
- Site navigation → Supported platforms page: navigates to
- Site navigation → Image links page: navigates to
- Supported platforms page → Frontend assets: loads
- Image links page → Frontend assets: loads
- Documentation TOC → Feature design documents: indexes
- Feature design documents → Configuration and DB design: includes
- Feature design documents → Management API design: includes
- Feature design documents → Forwarding and platform design: includes
- Feature design documents → Runtime integration references: includes
- Configuration and DB design → SONiC runtime ecosystem: documents configuration and databases
- Management API design → SONiC runtime ecosystem: documents APIs
- Forwarding and platform design → SONiC runtime ecosystem: documents forwarding and ASIC boundary
- Runtime integration references → SONiC runtime ecosystem: documents integration and lifecycle
- Image link metadata → Image link generator: input to
- Image link generator → Image links page: publishes links for
- Platform list generator → Supported platforms page: publishes list for
- GitHub Actions → Image link generator: runs
- GitHub Actions → Platform list generator: runs
- Project governance → Contribution process: governs
- Project governance → Maintainer and conformance: defines processes through
- Contribution process → GitHub Actions: integrates contributions via