Skip to content

Super8Four/infralynx-docs

InfraLynx Documentation

Docs Build License Version Node.js PostgreSQL MS%20SQL%20Server MariaDB Documentation

Official documentation, standards, architecture, and deployment guides for InfraLynx.

Quick Links: Documentation Site | Platform Repo | Docs Repo | Standards Repo | Design Repo | Infra Repo

Overview

infralynx-docs is the canonical written source for InfraLynx architecture, operations, API contracts, governance, release notes, legal position, and contributor onboarding. It explains how the platform works and how the rest of the repository ecosystem fits together.

Current Status

  • Repository version: v0.12.0-alpha+chunk31.1
  • Program snapshot: v0.1.0-alpha+chunk31
  • Current chunk: 31.1
  • Current phase: Scale / Reliability
  • Next milestone: Chunk 32 -> API Versioning
  • Target release: v1.0.0

The docs repo tracks the active platform build and is maintained as a first-class product artifact, not a secondary export.

Roadmap Progress

Completed:

  • Core platform
  • IPAM
  • DCIM
  • Operations
  • Security
  • Performance

In Progress:

  • Reliability / API hardening

Upcoming:

  • Product differentiators
  • Visual subnet planning
  • Network containers
  • AI integrations

Tech Stack

  • Markdown and MkDocs Material
  • GitHub Pages publishing
  • InfraLynx architecture, API, and operations source material
  • Cross-repo governance and ADR documentation

Getting Started

  1. Install MkDocs dependencies in your environment.
  2. From this repo, build the site:
python -m mkdocs build --strict
  1. Serve locally if needed:
python -m mkdocs serve

Documentation Links

InfraLynx Repository Ecosystem

Contribution Guidelines

Documentation changes should land with the behavior or policy changes they describe whenever possible. Use CONTRIBUTING.md and the standards repo as the operating baseline.

Support InfraLynx

Support continued development of InfraLynx:

https://buymeacoffee.com/infralynx

Support helps fund:

  • New features
  • Documentation
  • Hosted services
  • Enterprise integrations

License

This repository is licensed under Apache 2.0. See LICENSE and NOTICE.

Support / Community

About

Official documentation, standards, architecture, and deployment guides for InfraLynx.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors