S
Supanote
Sign in Sign up
Documentation Specs

Markdown & Documentation Templates

Standardized REST API specifications, Architecture Decision Records (ADRs), Changelog files, PR templates, and llms.txt declarations.

markdown Verified Starter

Modern Open-Source GitHub README.md Specification Template

Clean, comprehensive developer README template featuring status badges, live preview section, architecture overview, and quick-start.

# Project Name 🚀

> A fast, lightweight, and modern application built for developers.

[![Build...
markdown Verified Starter

RESTful API Documentation Markdown Specification Template

Clean, developer-friendly REST API documentation with endpoint matrices, authentication headers, and cURL examples.

# API Specification — Service Name

Base URL: `https://api.example.com/v1`

## Authentication

All API requests require a Bearer token in the `Authorization` header:

```bash
Authorization: Bearer <API_TOKEN>
```

---

## Endpoints

### 1. List...
markdown Verified Starter

Keep a Changelog Standard Semantic Versioning Template

Standard CHANGELOG.md following Keep a Changelog specifications with Added, Changed, Deprecated, Removed, and Security sections.

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic...
markdown Verified Starter

GitHub Pull Request & Issue Quality Checklist Template

Production .github/pull_request_template.md featuring breaking changes detection, test checklists, and architectural context.

## 📌 Summary of Changes

A concise description of what this pull request accomplishes and the problem it solves.

- Relates to issue: #142
- Closes issue: #158

---

## 🛠 Type of Change

- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
-...
markdown Verified Starter

Architecture Decision Record (ADR) Engineering Template

Standard ADR template (Michael Nygard format) documenting architectural decisions, status, context, consequences, and tradeoffs.

# ADR 007: Adoption of SQLite WAL Mode for Single-Node Workloads

## 📊 Status
**Accepted** (Supersedes ADR 003) — 2026-10-09

## 👥 Deciders
- Architecture Team
- Core Infrastructure Lead

---

## 🔍 Context & Problem Statement

Our application...
markdown Verified Starter

Open-Source Contributing Guidelines (CONTRIBUTING.md) Template

Comprehensive guidelines for open-source contributors covering issue reporting, branch naming conventions, and local dev setup.

# Contributing to Project Name

Thank you for investing your time in improving this open-source project!

## 📜 Code of Conduct

This project adheres to the Contributor Covenant. By participating, you are expected to uphold this code. Please report...
markdown Verified Starter

GitHub Security Policy (SECURITY.md) Vulnerability Template

Standard GitHub SECURITY.md template outlining supported versions, responsible disclosure SLA, and PGP key fingerprint.

# Security Policy

We take the security of our codebase, infrastructure, and user data extremely seriously. We appreciate the responsible disclosure of any security vulnerability.

---

## 🛡 Supported Versions

Security updates and patches are...
markdown Verified Starter

llms.txt Standard Specification Template for AI Agents

Clean llms.txt standard layout for LLM crawlers and AI coding assistants like Claude, Cursor, and ChatGPT.

# Project Name — AI Agent & LLM Context Guide

> Project Name is a high-speed, lightweight developer snippet repository with zero client-side tracking, native Markdown rendering, and instant raw API endpoints.

This file provides structured context...
Notification