info/the-documentation-compendium
1
0
Fork 0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-03 01:52:42 +02:00
Code Issues Releases Wiki Activity

Merge branch 'master' of https://github.com/kylelobo/The-Documentation-Compendium

Browse Source
This commit is contained in:
Kyle Lobo
2019-07-24 01:39:07 +05:30
parent 569f327afc 84cf038718
commit 045ede860c
3 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
en/CONTRIBUTING.md
View File

@@ -3,8 +3,8 @@
- Contributing to The Documentation Compendium is fairly easy. This document shows you how to get started
## General
- The [Codebase Structure](/CODEBASE_STRUCTURE.md) has detailed information about how the various files in this project are structured
- Please ensure that any changes you make are in accordance with the [Coding Guidelines](/CODING_GUIDELINES.md) of this repo
- The [Codebase Structure](./CODEBASE_STRUCTURE.md) has detailed information about how the various files in this project are structured
- Please ensure that any changes you make are in accordance with the [Coding Guidelines](./CODING_GUIDELINES.md) of this repo
## Submitting changes

10
en/README_TEMPLATES/README.md
View File

@@ -1,9 +1,9 @@
### This folder contains various README Templates that one can use based on the type of project.
1. [Bot.md](/README%20Templates/Bot.md) - For if you have an awesome Bot that you want to share with others.
2. [Hackathon.md](/README%20Templates/Hackathon.md) - At a Hackathon and quickly need to set up a beautiful, thorough
1. [Bot.md](./Bot.md) - For if you have an awesome Bot that you want to share with others.
2. [Hackathon.md](./Hackathon.md) - At a Hackathon and quickly need to set up a beautiful, thorough
README that leaves a lasting impression on the judges? This is the template for you!
3. [IoT.md](/README%20Templates/IoT.md) - This repo nails down the nitty-gritties that go into documenting an IoT project.
4. [Minimal.md](/README%20Templates/Minimal.md) - Quickly set up a very basic, minimal README for your project.
5. [Standard.md](/README%20Templates/Standard.md) - A detailed, comprehensive template that covers all the major aspects
3. [IoT.md](./IoT.md) - This repo nails down the nitty-gritties that go into documenting an IoT project.
4. [Minimal.md](./Minimal.md) - Quickly set up a very basic, minimal README for your project.
5. [Standard.md](./Standard.md) - A detailed, comprehensive template that covers all the major aspects
of a README.

4
en/TODO.md
View File

@@ -2,9 +2,9 @@
---
- [x] Document the README.md file in the [README Templates](/README%20Templates) folder.
- [x] Document the README.md file in the [README_TEMPLATES](./README_TEMPLATES) folder.
- [ ] Make an IoT template (Refer to the various Arduino project documentations for assistance). This template must be detailed and should go in-depth into the various hardware terminologies.
- [ ] Make a minimal IoT template.
- [ ] Add a COMMIT_MESSAGE_GUIDELINES.md file.
- [ ] Translate the various [templates](https://github.com/kylelobo/The-Documentation-Compendium#templates) into different languages - Chinese, Spanish, Portuguese, Russian, etc.
- [ ] Translate the [templates](https://github.com/kylelobo/The-Documentation-Compendium#templates) into different languages - Chinese, French, German, Hindi, Italian, Japanese, Korean, Portuguese, Russian, Spanish, etc.