documentation
Document, Test & Discover APIs.
The modern open-source developer experience platform for your APIs. Create world-class API Docs with a built-in interactive playground which seamlessly turns to a full featured API Client.
Scalar is an open-source platform with: 🌐 Modern Rest API Client 📖 Beautiful API References ✨ 1st-Class OpenAPI/Swagger Support
documentation is a documentation generator. It's used to generate documentation from comments within your code. documentation processes JavaScript comments in the JSDoc format.
But don't worry! Even though it's embedded in your code, JSDoc is not code. It's a simple and standard syntax for writing documentation. You don't need to be a developer to use it.
Redoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions.
🐙 Guides, papers, lecture, notebooks and resources for prompt engineering.
Prompt engineering is a relatively new discipline for developing and optimizing prompts to efficiently use language models (LMs) for a wide variety of applications and research topics. Prompt engineering skills help to better understand the capabilities and limitations of large language models (LLMs).
rtfmbro provides always-up-to-date, version-specific package documentation as context for coding agents. An alternative to context7
Build mindmaps with plain text. Visualize your Markdown as mindmaps.
Related contents:
Ship documentation, like you ship code. Instant Open Source docs with zero configuration.
Meet the docs as code platform made for open-source developers. Publish beautiful online documentation instantly, from your code editor using markdown and a public GitHub repository.
Related contents:
Web Robots (also known as Web Wanderers, Crawlers, or Spiders), are programs that traverse the Web automatically. Search engines such as Google use them to index the web content, spammers use them to scan for email addresses, and they have many other uses.
Related contents:
Build excellent documentation with less effort. The beautiful & flexible React.js docs framework.
The framework for building documentation websites in any React.js frameworks. Fumadocs is a beautiful documentation framework for developers, flexible, performant, running on your React framework.
This document describes the XML schema for the Sitemap protocol.
The Sitemap protocol format consists of XML tags. All data values in a Sitemap must be entity-escaped. The file itself must be UTF-8 encoded.
🗃 Open source self-hosted web archiving. Takes URLs/browser history/bookmarks/Pocket/Pinboard/etc., saves HTML, JS, PDFs, media, and more…
ArchiveBox is a powerful, self-hosted internet archiving solution to collect, save, and view sites you want to preserve offline.
Le Kit de survie du créatif, initiative de l’association « Métiers graphiques », est un ensemble d’articles originaux rédigés par des professionnels du graphisme, destinés à orienter et informer tous ceux qui abordent ce secteur ou y évoluent déjà. En marge et en complément de l’ensemble des textes administratifs ou légaux déjà disponibles sur la toile, ce kit aborde le métier d’un point-de-vue concret, pratique, et éprouvé : chaque information que vous y trouverez est le résultat de l’expérience de son rédacteur, de ses tentatives, retours et conclusions.
Simple Accessibility Guidance for Beginners.
Easy-to-follow steps for beginners to review website accessibility.
Team knowledge base & wiki. A fast, collaborative, knowledge base for your team built using React and Node.js.
Your team’s knowledge base. Lost in a mess of Docs? Never quite sure who has access? Colleagues requesting the same information repeatedly in chat? It’s time to get your team’s knowledge organized.
✨ Recognize all contributors, not just the ones who push code ✨ This is a specification for recognizing contributors to an open-source project in a way that rewards every contribution, not just code. The basic idea is this: Use the project README (or another prominent public documentation page in the project) to recognize the contributions of members of the project community. People are giving themselves and their free time to contribute to open source projects in so many ways, so we believe everyone should be praised for their contributions (code or not).
GitHub page: https://github.com/all-contributors/all-contributors
Here you can find a list of charts categorised by their data visualization functions or by what you want a chart to communicate to an audience. While the allocation of each chart into specific functions isn't a perfect system, it still works as a useful guide for selecting chart based on your analysis or communication needs.
Runme runs Markdown. DevOps Notebooks Built with Markdown.
Runme is a tool that makes runbooks actually runnable, making it easier to follow step-by-step instructions. Shell/bash, Python, Ruby, Javascript/Typescript, Lua, PHP, Perl, and many other runtimes are supported via Runme's shebang feature. Runme allows users to execute instructions, check intermediate results, and ensure the desired outputs are achieved. This makes it an excellent solution for runbooks, playbooks, and documentation that requires users to complete runnable steps incrementally—making operational docs reliable and much less susceptible to bitrot.
A GNU Emacs major mode for keeping notes, authoring documents, computational notebooks, literate programming, maintaining to-do lists, planning projects, and more — in a fast and effective plain text system.
Org is a highly flexible structured plain text file format, composed of a few simple, yet versatile, structures — constructed to be both simple enough for the novice and powerful enough for the expert.
Related contents:
DevDocs combines multiple API documentations in a fast, organized, and searchable interface.
First, let me give a brief explanation of what column aggregation inheritance is and how it works. With column aggregation inheritance all classes share the same table, and all columns must exist in the parent. Doctrine is able to know which class each row in the database belongs to by automatically setting a "type" column so that Doctrine can cast the correct class when hydrating data from the database. Even if you query the top level column aggregation class, the collection will return instances of the class that each row belongs to.
The C4 model for visualising software architecture: Context, Containers, Components, and Code.
The C4 model was created as a way to help software development teams describe and communicate software architecture, both during up-front design sessions and when retrospectively documenting an existing codebase. It's a way to create maps of your code, at various levels of detail, in the same way you would use something like Google Maps to zoom in and out of an area you are interested in.
threat modelling configuration language with hcl.
There are many different ways in which a threat model can be documented. From a simple text file, to more in-depth word documents, to fully instrumented threat models in a centralised solution. Two of the most valuable attributes of a threat model are being able to clearly document the threats, and to be able to drive valuable change.
Brief visual explanations of machine learning concepts with diagrams, code examples and links to resources for learning more.
Documentation. Zero Clutter. Just Content.
Generate beautiful, lightweight static documentation sites from Markdown files.
There’s a lot of outdated information on the Web that leads new PHP users astray, propagating bad practices and insecure code. PHP: The Right Way is an easy-to-read, quick reference for PHP popular coding standards, links to authoritative tutorials around the Web and what the contributors consider to be best practices at the present time.
Gather all the documentation for your dependencies in one place instantly! 🪄
Your Independent Privacy and Security Resource. The guide to restoring your online privacy.
Massive organizations are monitoring your online activities. Privacy Guides is your central privacy and security resource to protect yourself online.
A magical documentation site generator. Simple and lightweight, No statically built html files, Multiple themes.
Docsify turns one or more Markdown files into a Website, with no build process required.
Uberlab is a collection of how-to guides for Uberspace 7. It is meant as an addition to the Manual, providing hands-on guides on how to get popular (or even niche) software running on our platform.
Master the command line, in one page.
Fluency on the command line is a skill often neglected or considered arcane, but it improves your flexibility and productivity as an engineer in both obvious and subtle ways. This is a selection of notes and tips on using the command-line that we've found useful when working on Linux. Some tips are elementary, and some are fairly specific, sophisticated, or obscure. This page is not long, but if you can use and recall all the items here, you know a lot.
The Patterns of Scalable, Reliable, and Performant Large-Scale Systems.
An updated and organized reading list for illustrating the patterns of scalable, reliable, and performant large-scale systems. Concepts are explained in the articles of prominent engineers and credible references. Case studies are taken from battle-tested systems that serve millions to billions of users.
A better alternative for securing our sensitive information online.
The Web Authentication API (also known as WebAuthn) is a specification written by the W3C and FIDO, with the participation of Google, Mozilla, Microsoft, Yubico, and others. The API allows servers to register and authenticate users using public key cryptography instead of a password.
reStructuredText (reST) is the default plaintext markup language used by both Docutils and Sphinx. Docutils provides the basic reStructuredText syntax, while Sphinx extends this to support additional functionality.
Related contents:
L'objectif de ce wiki est d'établir une base de connaissances technique communes et vulgarisées qui nous permettra à tous de profiter d'Internet et de l'espace de liberté que ce formidable outil nous offre.
This project keeps the Linux Kernel Module Programming Guide up to date, with working examples for recent 5.x and 6.x kernel versions. The guide has been around since 2001 and most copies of it on the web only describe old 2.6.x kernels.
Explain complex software systems. Align on technical decisions across your software engineering and product teams.
Records Ansible as Asciidoc files. Uses kroki/vegalite for charts.
PHPDocFill is a simple tool that allows you to easily complete your PHP script documentation in PHPDoc format
Kalmia is a Go tool with a web interface for managing RsPress documentation. It supports multiple versions, multiple users, and includes a markdown editor for easy edits. Please visit our website for more information on how to use Kalmia and its features.
Given a version number MAJOR.MINOR.PATCH, increment the:
MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards compatible manner, and
PATCH version when you make backwards compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
Publish presentation-rich content from a concise and comprehensive authoring format.
AsciiDoc is a plain text markup language for writing technical content. It’s packed with semantic elements and equipped with features to modularize and reuse content. AsciiDoc content can be composed using a text editor, managed in a version control system, and published to multiple output formats.
Related contents:
A CMS for Manuals, Documentations and Handbooks.
Publish websites, PDFs, and ePubs from Markdown files. An open source cms tailored for small enterprises to create documentations, manuals, knowledge bases, wikis, handbooks, reports, ebooks, and more.
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introductory tutorial, then check the User Guide for more information.
Related contents:
This book uses MySQL challenges as case studies to explore problem analysis and resolution strategies. Readers will gain a deeper appreciation for logical reasoning, data structures, algorithms, and more through practical examples and insightful discussions.
This document is an attempt to systematically describe best practices using Terraform and provide recommendations for the most frequent problems Terraform users experience.
React Documentation Framework. Minimal Documentation Framework, powered by React + Vite. Vocs is a minimal static documentation generator designed to supercharge your documentation workflow, built with modern web technologies.
Local-first documentation for AI agents. Up-to-date docs for AI agents — local, instant, plug and play.
Context is an MCP server backed by a community-driven package registry with 100+ popular libraries already built and ready to use. When your AI agent needs documentation, it searches the registry, downloads the right package, and queries it locally — all automatically.
Related contents:
Find the documentation for all Kubernetes resources, properties, types, and examples.
Python is an amazing programming language that will help you become better SEOs.
You can use python for SEO by dropping your reliance on Excel and stop using spreadsheets, by leveraging APIs, automating the boring tasks and by implementing machine learning algorithms.
This is a true beginner to expert guide to learn Python for SEO.
XWiki Platform is a generic wiki platform offering runtime services for applications built on top of it.
XWiki Commons, XWiki Rendering, and XWiki Platform are part of the XWiki.org software forge. They are released together and share the same version.
Learn Accessibility An evergreen accessibility course and reference to level up your web development.
Natural Docs is an open-source documentation generator for multiple programming languages. You document your code in a natural syntax that reads like plain English. Natural Docs then scans your code and builds high-quality HTML documentation from it.
A (somewhat opinionated) list of SQL tips and tricks that I've picked up over the years.
There's so much you can you do with SQL but I've focused on what I find most useful in my day-to-day work as a data analyst and what I wish I had known when I first started writing SQL.
From the basics to advanced topics with simple, but detailed explanations.
Accessibility Myths debunked promotes accessibility for the web by correcting false beliefs.
The Pinouts Book is a free digital book created for designers and engineers as a quick reference for remembering the different pinout functions in your electronics projects. The book covers 130 commonly used components (view list), such as connectors, single board computers, dev boards, memory cards, microcontroller chips, and more.
An explainer for doing web development using only vanilla techniques. No tools, no frameworks — just HTML, CSS, and JavaScript.
The Darwin Information Typing Architecture (DITA) specification defines a set of document types for authoring and organizing topic-oriented information, as well as a set of mechanisms for combining, extending, and constraining document types.
Related contents: