From f37365edb791e5af7f911e1d94f29b6374342cbf Mon Sep 17 00:00:00 2001 From: Kyle Lobo Date: Wed, 24 Jul 2019 01:21:05 +0530 Subject: [PATCH 1/4] Update URL for README_TEMPLATES --- en/TODO.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/TODO.md b/en/TODO.md index f4244e7..2685fcf 100644 --- a/en/TODO.md +++ b/en/TODO.md @@ -2,7 +2,7 @@ --- -- [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. From ac898b117d9eaee60b76d5baf35a7cd48115b9b4 Mon Sep 17 00:00:00 2001 From: Kyle Lobo Date: Wed, 24 Jul 2019 01:24:41 +0530 Subject: [PATCH 2/4] Fix URLs --- en/CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en/CONTRIBUTING.md b/en/CONTRIBUTING.md index 7509f12..938d84c 100644 --- a/en/CONTRIBUTING.md +++ b/en/CONTRIBUTING.md @@ -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 From 9ab2853e7ab8ff50ed37b514b4b90d4a64e0a002 Mon Sep 17 00:00:00 2001 From: Kyle Lobo Date: Wed, 24 Jul 2019 01:26:36 +0530 Subject: [PATCH 3/4] Fix URL for README_TEMPLATES --- en/TODO.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en/TODO.md b/en/TODO.md index 2685fcf..8c7aad0 100644 --- a/en/TODO.md +++ b/en/TODO.md @@ -2,9 +2,9 @@ --- -- [x] Document the README.md file in the [README_TEMPLATES](/README_TEMPLATES) 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. From 84cf038718e7ed1852985b3005b0ce55ebb8db9e Mon Sep 17 00:00:00 2001 From: Kyle Lobo Date: Wed, 24 Jul 2019 01:28:05 +0530 Subject: [PATCH 4/4] Fix URLs --- en/README_TEMPLATES/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/en/README_TEMPLATES/README.md b/en/README_TEMPLATES/README.md index c59592a..789c945 100644 --- a/en/README_TEMPLATES/README.md +++ b/en/README_TEMPLATES/README.md @@ -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.