15 个仓库
Documentation tracked in version control for historical accuracy.
Distinguishing note: Focuses on the versioning aspect of documentation.
Explore 15 awesome GitHub repositories matching software engineering & architecture · Versioned Documentation. Refine with filters or upvote what's useful.
这是一个由社区策划的开源软件目录,专为在私有服务器环境和家庭实验室中部署而设计。它作为发现主流云服务独立自托管替代方案的综合资源,使用户能够保持对数字基础设施的完全数据所有权和控制权。 该目录通过层级分类法构建,将庞大的应用程序集合组织成逻辑类别,范围从媒体管理和数据分析到私有通信和团队生产力工具。它通过协作同行评审流程脱颖而出,社区成员验证每个提交的质量和相关性,以确保目录保持准确和可靠。 该项目涵盖了广泛的能力领域,包括基础设施自动化、基于容器的服务部署和声明式配置管理。这些工具协助用户维护可复现的服务器环境,并管理私有硬件上的复杂服务依赖。 该目录作为版本控制仓库进行维护,确保所有更新和社区驱动的变更都是可追踪且透明的。
Enables the publication and management of multiple versions of technical documentation.
This project is a community-driven repository that serves as a comprehensive reference guide for mastering the command line interface on macOS. It functions as a curated index of high-quality tools, documentation, and best practices designed to assist users in navigating terminal environments and optimizing their development workflows. The directory distinguishes itself through a decentralized, peer-reviewed curation model. By leveraging a structured submission workflow, the content is continuously updated and vetted by contributors to ensure the accuracy and relevance of the listed resources
Ensures historical accuracy of documentation through distributed version control tracking.
This project is an architecture reference and coding standard for the Angular framework. It provides guidelines for organizing files, components, and services into a logical hierarchy to maintain consistent and readable TypeScript code. The guide focuses on enterprise application architecture and frontend code governance. It establishes a shared set of structural guidelines and development standards to ensure long-term maintainability and to assist in bootstrapping new projects without technical debt. The resource covers modular architecture guidelines, pattern-based code standardization, an
Maintains separate sets of instructional content mapped to specific framework versions to prevent API mismatches.
Context Hub is a retrieval-augmented generation framework and context management system designed to provide large language model agents with curated, versioned markdown documentation. It functions as a documentation provider that delivers precise API references and technical context to reduce hallucinations and token waste. The system incorporates an agentic memory layer that maintains persistent local annotations and user feedback to improve how agents retrieve task-specific knowledge. It uses a version-controlled repository of technical documentation designed for both machine readability an
Tracks documentation in version control to ensure AI agents receive the correct API specifications for specific versions.
This project consists of the LaTeX source files and build configurations used to generate PDF versions of a textbook. It provides a multilingual document build system to produce consistent PDF editions of the same text across different languages. The repository includes a LaTeX document formatter with linting and formatting tools to standardize indentation and style. It also contains a technical text errata tracker to maintain a structured record of typos and factual corrections. The project covers LaTeX document publishing, multilingual book production, and technical document versioning. Th
Tracks errata and corrections across different document releases using versioned source control.
Fumadocs is a documentation framework designed for building content-heavy technical websites using MDX. It functions as a static site generator that transforms structured text files into optimized, interactive web pages, providing a comprehensive toolset for managing technical content, API references, and versioned guides. The platform distinguishes itself through a deep integration of interactive components and AI-ready features. It includes a library of pre-built interface elements that allow developers to embed live API playgrounds, request snippets, and schema-based documentation directly
Maintains distinct sets of documentation for different software releases to ensure users access information relevant to their specific version.
Read the Docs is an automated documentation hosting platform that transforms source files from version control into published websites. It functions as a documentation pipeline that updates content automatically on every commit to keep technical manuals in sync with software releases. The platform provides specialized hosting for static site documentation and integrates as a CI/CD pipeline for documentation workflows. It utilizes a webhook-driven build system to trigger documentation rebuilds automatically by listening for push events from remote version control systems. The service supports
Organizes and hosts multiple versions of project manuals by pulling specific tags or branches from repositories.
This project is an automated release note tool and markdown history generator that transforms repository activity into structured documentation. It functions as a GitHub API client and CI/CD pipeline component, aggregating tags, issues, and pull requests to produce categorized summaries of project changes. The tool distinguishes itself through native GitHub Enterprise integration, supporting custom API endpoints for self-hosted server instances. It employs a label-based categorization system to group changes into specific sections and utilizes personal access tokens or OAuth to manage API rat
Produces categorized logs of bug fixes and enhancements to document software version history.
该项目是一个全面的 Kubernetes 教育资源和操作手册。它作为一个技术参考,用于在不同环境中安装、管理和扩展容器编排集群,涵盖了维护容器化应用程序所需的核心架构原则和系统组件。 该资源提供了结构化的集群管理指南,包括高可用性设置、资源控制和数据备份操作。它还作为一个安全审计和故障排除手册,提供使用行业标准基准识别节点漏洞以及解决网络、存储和 Pod 环境中故障的说明。 该文档涵盖了广泛的功能领域,包括跨不同操作系统的集群部署、通过网络策略和服务治理进行的流量管理,以及访问控制和身份机制的实施。它还解决了工作负载管理、资源分配和 API 功能扩展的问题。 该内容作为一个基于 Markdown 的系统进行管理,使用静态站点生成将结构化的技术指南转换为预渲染的 HTML 页面。
Organizes technical documentation by release versions to ensure guides match the specific cluster API.
RoseDB 是一个持久化键值数据库和日志结构存储引擎。它作为一个轻量级存储系统,利用日志结构哈希表和 Bitcask 引擎实现,提供快速的数据检索和磁盘备份持久化。 该系统作为原子事务引擎运行,将多个读写操作分组为单个单元以保持数据一致性。它通过支持插入、查找和删除操作的键值模型来处理数据。 该数据库提供批量数据处理和原子更新功能。此外,该项目还包括版本化内容管理和多语言内容翻译功能。
Provides capabilities to organize and locate documentation versions specific to particular software releases.
phpDocumentor 是一个 PHP API 文档生成器和源代码分析器,将 PHP 文件和 DocBlocks 转换为结构化的 HTML API 参考。它作为一个静态站点生成器和自动化文档工具,旨在使技术文档与代码变更保持同步。 该项目的独特之处在于它充当 UML 图生成器,基于源代码分析通过 PlantUML 生成类图和架构图。它还支持技术手册编写,在自动生成的 API 参考旁边渲染手写的 Markdown 和 ReStructuredText 指南。 该工具提供了广泛的源代码分析能力,包括抽象语法树的生成、元数据标记以及文档继承的管理。它包括用于代码架构、元素可见性控制和版本化文档管理的可视化工具。 构建可以通过 XML 配置文件进行管理,以在持续集成管道中实现自动化生成。
Organizes output into distinct folders based on project version numbers to maintain separate documentation sets.
该项目是 PyTorch 深度学习框架技术指南和 API 参考的中文翻译版。它作为一个本地化的知识库和参考资料,使非英语母语者能够访问深度学习文档。 该文档涵盖了 PyTorch 的全面能力,包括神经网络模型开发、自动微分以及后端内核的实现。它提供了关于分布式训练策略、通过 ONNX 和 C++ 等格式进行模型部署以及各种模型优化和量化技术的详细指导。 该项目利用社区驱动的翻译管道和分布式贡献模型来维护版本同步的内容。技术资料使用 Markdown 组织,并通过静态网站生成渲染为可导航的网站。
Aligns translated documentation content with specific software release versions using git branches.
Fern is a toolset for managing API specifications, generating type-safe client libraries, and producing hosted developer documentation. It provides a utility for validating, transforming, and exporting API definitions into standardized OpenAPI formats, serving as a system to maintain a consistent source of truth for API designs. The project differentiates itself through an automated SDK distribution pipeline that publishes generated libraries to package managers such as npm, PyPI, Maven, and NuGet. It also includes an AI-powered search assistant trained on API and SDK specifications to answer
Provides a mechanism to organize and toggle between different versions of technical documentation.
This is the official repository for submitting and managing changes to the Laravel framework's documentation. It operates as an open source documentation platform where community contributions are organized through a versioned documentation structure, with each major or minor release maintaining its own set of documentation files. Documentation content is stored as plain Markdown files in a version-controlled repository, with changes tracked through Git commits and routed to specific branches that correspond to distinct release versions. Contributions are submitted via pull requests, enabling
Maintains separate documentation files for each major or minor release, allowing parallel maintenance across versions.
Zensical is a documentation framework and markdown static site generator designed for authoring modular technical topics. It includes a static site build orchestrator that uses a dependency graph to parallelize asset compilation and perform differential updates. The project features a federated search engine that aggregates results from multiple documentation projects using a combination of inverted indexes and vector-based semantic search. It also includes an LLM context generator to extract lean, semantic information from modular topics to optimize prompts for large language models. The sy
Provides a mechanism to deploy and manage multiple versioned iterations of technical documentation based on branching strategies.