Skip to content

Commit 27c444e

Browse files
committed
moving toc
1 parent e8f8f31 commit 27c444e

File tree

3 files changed

+15
-13
lines changed

3 files changed

+15
-13
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# ProjectTemplate
2+
The project template for Code for Baltimore github projects. This project will help your project get started by giving you:
3+
* A standard issues template
4+
* A standard pull request
5+
* A standard docs folder with example documentation.
6+
* A big thumbs up :thumbsup:
7+
18
<!-- TOC -->
29

310
- [ProjectTemplate](#projecttemplate)
@@ -10,13 +17,6 @@
1017

1118
<!-- /TOC -->
1219

13-
# ProjectTemplate
14-
The project template for Code for Baltimore github projects. This project will help your project get started by giving you:
15-
* A standard issues template
16-
* A standard pull request
17-
* A standard docs folder with example documentation.
18-
* A big thumbs up :thumbsup:
19-
2020
## Documentation
2121
We've included a `docs` folder with a template [Tech Spec](/docs/Tech_Spec.md) and [Best Practices](/docs/Best_Practices.md) document, though using Github's Wiki capabilities is also a good idea. This will get you started with documenting your project. Other documents and relevant information that has no other place can live in the `docs` folder. Replace this paragraph with a brief breakdown of what you've included in your `docs` folder.
2222

docs/Best_Practices.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Best Practices
2+
Code for Baltimore projects should be built with the intention of deploying on [Heroku](https://heroku.com) or [Netlify](https://netlify.com). For details on Heroku Best Practices see their [developer documentation](https://devcenter.heroku.com/articles/node-best-practices).
3+
14
<!-- TOC -->
25

36
- [Best Practices](#best-practices)
@@ -14,9 +17,6 @@
1417

1518
<!-- /TOC -->
1619

17-
# Best Practices
18-
Code for Baltimore projects should be built with the intention of deploying on [Heroku](https://heroku.com) or [Netlify](https://netlify.com). For details on Heroku Best Practices see their [developer documentation](https://devcenter.heroku.com/articles/node-best-practices).
19-
2020
## Project Management
2121
We are using Github Issues to track outstanding issues and work for projects.
2222

docs/Tech_Spec.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
2+
3+
# Tech Spec
4+
The _Tech Spec_ is an important part of a project, but it's a part that's often overlooked or skipped. The intention of this document is to organize everyone's thoughts on the project into one simple, succinct document. It doesn't have to be super detailed but filling out this document will help keep everyone focused on the project goal.
5+
16
<!-- TOC -->
27

38
- [Tech Spec](#tech-spec)
@@ -12,9 +17,6 @@
1217

1318
<!-- /TOC -->
1419

15-
# Tech Spec
16-
The _Tech Spec_ is an important part of a project, but it's a part that's often overlooked or skipped. The intention of this document is to organize everyone's thoughts on the project into one simple, succinct document. It doesn't have to be super detailed but filling out this document will help keep everyone focused on the project goal.
17-
1820
## Overview
1921
This section should be comprised of 1-3 short paragraphs giving a high-level overview of what the project hopes to accomplish. This overview should quickly define what the project hopes to do, what this document will cover, and what will not be covered.
2022

0 commit comments

Comments
 (0)