11 रिपॉजिटरी
Code snippets and instructions demonstrating the usage of functions, classes, or APIs.
Distinct from API Usage Examples: Focuses on educational usage examples for library functions, distinct from API-specific request documentation.
Explore 11 awesome GitHub repositories matching education & learning resources · Documentation Usage Examples. Refine with filters or upvote what's useful.
This project is an educational platform and research toolkit designed to teach deep learning through a combination of mathematical theory, visual diagrams, and executable code. It provides a comprehensive environment for building, training, and evaluating neural networks, grounding complex concepts in interactive computational notebooks that allow for hands-on experimentation. The framework distinguishes itself by interleaving theoretical foundations—including linear algebra, calculus, and probability—with practical implementations across multiple industry-standard libraries. It supports flex
Provides detailed instructions, parameter descriptions, and usage examples for library functions and classes.
mdBook is a documentation build system and static site generator designed to compile collections of Markdown files into structured, navigable web-based books. It provides a comprehensive framework for managing technical documentation, featuring a hierarchical table of contents, integrated full-text search, and automated build processes that transform source content into ready-to-deploy HTML websites. The project distinguishes itself through a highly modular pipeline architecture that supports custom preprocessors and swappable rendering backends. This allows authors to intercept and modify co
Validates embedded code examples by executing them during the build process to ensure accuracy.
Best-README-Template is a standardized framework for creating consistent project documentation. It provides a structured markdown boilerplate designed to help developers communicate project requirements, installation steps, and contribution guidelines to new users. The template utilizes modular sectional composition and placeholder-based variable injection to simplify the maintenance of project metadata and contact details. By using predefined structural patterns, it ensures that documentation remains consistent across diverse software repositories while remaining readable in both raw text an
Structures code examples and demonstrations to communicate project usage effectively.
Cargo is the official build system and package manager for the Rust programming language. It provides a unified command-line interface that orchestrates the entire development lifecycle, including compiling source code, managing complex dependency graphs, running tests, and distributing packages through a centralized registry. By utilizing declarative manifest files, it ensures that builds remain reproducible and consistent across different environments. The tool distinguishes itself through its deep integration with the Rust compiler and its sophisticated approach to project management. It f
Searches workspace crates for function calls and includes them as examples within generated documentation.
Scalar is a platform for building and managing API specifications, focusing on OpenAPI and AsyncAPI standards. It provides tools to generate interactive API references with embedded testing interfaces, create mock servers for pre-implementation testing, and build offline-first API clients that sync with backend frameworks. The platform also supports version upgrades of specifications to maintain compatibility and includes command-line utilities for local development and document management. The project distinguishes itself through automated release workflows that generate changelogs and publi
Produces OpenAPI test documentation to validate API behavior and demonstrate specification usage.
mitmproxy2swagger is a tool that transforms captured mitmproxy network traffic into structured OpenAPI schemas for reverse-engineering REST APIs. It functions as an OpenAPI schema converter and network traffic documentation utility, extracting API endpoints and data structures from captured network packets to create formal technical references. The tool enables the reconstruction of undocumented APIs by converting intercepted HTTP request and response patterns into specifications. It supports merging multiple traffic capture files into a single schema to incrementally expand an API map and ut
Adds sample headers and body data from captured network traffic to the resulting OpenAPI specification.
Linux工具快速教程
Teaches tool usage through concrete command examples with common parameter combinations.
This project serves as a documentation hub and specification repository for official Docker images. It functions as a metadata-driven documentation generator that transforms structured content files into markdown files and readmes for public distribution. The repository provides technical guides and configuration standards for deploying containerized software across multiple CPU architectures. It includes detailed manuals for configuring environment variables, volume mounts, and network settings to ensure consistent image deployments. The documentation covers a broad range of containerized e
Integrates practical Docker Compose examples into documentation to demonstrate image usage.
TSDoc TypeScript कोड में संरचित टिप्पणियाँ लिखने के लिए एक दस्तावेज़ीकरण मानक और विनिर्देश है। यह विभिन्न टूलिंग में सुसंगत पार्सिंग और रेंडरिंग सुनिश्चित करने के लिए सोर्स कोड के भीतर मेटाडेटा, टैग्स और क्रॉस-रेफरेंस को परिभाषित करने के लिए एक पोर्टेबल सिस्टम प्रदान करता है। इस प्रोजेक्ट में एक डॉक कमेंट पार्सर शामिल है जो टिप्पणियों को एक संरचित सिंटैक्स ट्री में परिवर्तित करता है और एक वैलिडेटर जो सिंटैक्स स्थिरता को लागू करता है। यह बाहरी कॉन्फ़िगरेशन फ़ाइलों के माध्यम से कस्टम दस्तावेज़ीकरण टैग्स की परिभाषा की अनुमति देता है और विनिर्देश अनुपालन में सहायता के लिए कई सिंटैक्स वैलिडेशन मोड्स का समर्थन करता है। यह विनिर्देश API दस्तावेज़ीकरण की आवश्यकताओं की एक विस्तृत श्रृंखला को कवर करता है, जिसमें रिलीज़ चरणों, स्थिरता और अवमूल्यन को चिह्नित करना शामिल है। यह फ़ंक्शन पैरामीटर्स, रिटर्न मानों और अपवाद प्रकारों का विवरण देने के साथ-साथ आंतरिक दृश्यता, इनहेरिटेंस और घोषणाओं के बीच क्रॉस-रेफरेंसिंग को मैनेज करने का समर्थन करता है।
Allows defining documentation sections as illustrative usage examples with optional titles and code samples.
UnityLibrary is a game engine asset library providing a collection of reusable scripts, shaders, and templates for development within the Unity engine. It functions as a boilerplate template set and an editor extension suite designed to automate common tasks and reduce repetitive setup. The project includes a collection of pre-built material shaders and visual effects that can be applied to surfaces without writing custom shader code. It also provides utility scripts and editor tools to enhance the native development workflow. The library covers project bootstrapping through the use of prede
Ships annotated code samples and technical guides demonstrating feature usage and best practices.
Dokka is an extensible documentation engine designed to generate structured API reference materials for Kotlin projects. By parsing source code and comments, it functions as a static site generator that transforms codebases into readable documentation. It integrates directly into development workflows as a build system plugin, allowing for the automated creation of reference materials during the standard compilation process. The project distinguishes itself through a modular, plugin-driven processing pipeline that allows developers to modify the generation workflow, customize output formats,
Embeds live, verifiable code samples from existing functions directly into documentation.