📢 Various README templates & tips on writing high-quality documentation that people want to read.
-
Updated
Mar 24, 2024
📢 Various README templates & tips on writing high-quality documentation that people want to read.
💻🔥CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket)
📖 Highly customizable Project Docs / Wiki / Knowledge Base / Notes template for Hugo Website Builder. 创建项目文档
A template README for projects
📝 This README draws inspiration from @othneildrew (https://github.com/othneildrew/Best-README-Template), meticulously adapted and enhanced by @franckferman to align with personal project requirements and stylistic preferences.
Template repository aiming creation of the runbooks combined with basic lightweight documentation portal based on mkdocs, plantuml diagrams, and set of selected plugins
[🚀] Kickstart is a GitHub repository README template crafted for user-friendly navigation and modular flexibility, allowing you to customize sections based on your specific requirements.
This repository contain some papers on indoor navigation. We used these papers to built a small model of indoor navigation which is fast and efficient. Documentation and python code of the project is given in the form of word document.
collection of catalog and open layer (eps file -use Adobe Illustrator) files useful to create project catalog.
Project charter is a statement of the scope, objectives, and participants in a project.
Repository for storing practice results in the Learning Intermediate Android Application Development class on Dicoding
My personal GitHub Pages website (theme forked from Chirpy)
A automated way to create project's document for Ineuron Portal Projects.
A example of project docs using docsify, and a tool to automate implementing project docs
Personal prefered common documentation boilerplate
The overall objective of this project is to provide a ready-to-use documentation model with English/French bilingual parameters and versioning parameters.
AWS and Udacity are collaborating to educate developers of all skill levels to get started with ML.
Add a description, image, and links to the project-documentation topic page so that developers can more easily learn about it.
To associate your repository with the project-documentation topic, visit your repo's landing page and select "manage topics."