Skip to content

Commit

Permalink
docs: add decisions
Browse files Browse the repository at this point in the history
  • Loading branch information
kentcdodds committed May 25, 2024
1 parent c2f95f9 commit 5630298
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Epic Web Config Docs

This package is pretty simple and small so the docs can been found in the root.
However, there are decision documents in this folder that you may find
interesting.
12 changes: 12 additions & 0 deletions docs/decisions/000-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Title

Date: YYYY-MM-DD

Status: proposed | rejected | accepted | deprecated | superseded by
[0005](0005-example.md)

## Context

## Decision

## Consequences
28 changes: 28 additions & 0 deletions docs/decisions/001-reset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Reset

Date: 2024-05-25

Status: accepted

## Context

There are some things I want "fixed" in every TypeScript project. For details
and examples, check
[the docs for `@total-typescript/ts-reset`](https://www.totaltypescript.com/ts-reset).

In addition to what's available in the `ts-reset` package, I also want to have
css variable support in the `style` prop of React elements.

I want to handle that automatically in the tsconfig, but the problem is you
can't disable it, so it's all or nothing and there could be situations where you
wouldn't want the reset to be applied.

## Decision

We'll create a `reset.d.ts` file and consumers will have to include it in their
`includes` manually.

## Consequences

It's a bit of extra work, and it's an extra file we have to expose, but it
strikes the best balance.
7 changes: 7 additions & 0 deletions docs/decisions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Decisions

This directory contains all the decisions we've made for this starter template
and serves as a record for whenever we wonder why certain decisions were made.

Decisions in here are never final. But these documents should serve as a good
way for someone to come up to speed on why certain decisions were made.

0 comments on commit 5630298

Please sign in to comment.