Skip to content

Commit aa6ed1b

Browse files
authored
Merge pull request #24 from CodeForBaltimore/revjtanton/slight-toc-tweaks
moving toc
2 parents e8f8f31 + 10abdbc commit aa6ed1b

File tree

3 files changed

+14
-8
lines changed

3 files changed

+14
-8
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1+
# ProjectTemplate
2+
The project template for Code for Baltimore github projects.
3+
14
<!-- TOC -->
25

36
- [ProjectTemplate](#projecttemplate)
7+
- [What is this?](#what-is-this)
48
- [Documentation](#documentation)
59
- [Setup](#setup)
610
- [Using this product](#using-this-product)
@@ -10,8 +14,8 @@
1014

1115
<!-- /TOC -->
1216

13-
# ProjectTemplate
14-
The project template for Code for Baltimore github projects. This project will help your project get started by giving you:
17+
## What is this?
18+
This project will help your project get started by giving you:
1519
* A standard issues template
1620
* A standard pull request
1721
* A standard docs folder with example documentation.

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)