Skip to content

Commit

Permalink
docs: Updates markdown docs to only have one h1 (#1418)
Browse files Browse the repository at this point in the history
  • Loading branch information
TimDeve committed Apr 21, 2022
1 parent 9d9f982 commit 5d23388
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 9 deletions.
2 changes: 0 additions & 2 deletions docs/DynamicSemantics.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ This document will help us rewrite Carp's dynamic evaluator (defined in Eval.hs)

<hr>

# Semantics

## Index
[TODO]

Expand Down
12 changes: 6 additions & 6 deletions docs/ReleaseChecklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,30 @@

Do all of these things (somewhat) in order:

# 1. Update Cabal project version
## 1. Update Cabal project version

See the second line of the file [CarpHask.cabal](../CarpHask.cabal).

# 2. Update the "Welcome to Carp X.Y.Z" REPL message
## 2. Update the "Welcome to Carp X.Y.Z" REPL message

See [Main.hs](../App/Main.hs).

# 3. Update the blurb in README.md
## 3. Update the blurb in README.md

See [README.md](../README.md)

# 4. Update the changelog
## 4. Update the changelog

See [CHANGELOG.md](../CHANGELOG.md)

# 5. Make a commit on master
## 5. Make a commit on master

```bash
$ git add .
$ git commit -m "build: Release X.Y.Z"
```

# 6. Tag the commit and push it
## 6. Tag the commit and push it

```bash
$ git tag vX.Y.Z
Expand Down
2 changes: 1 addition & 1 deletion docs/Tooling.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
## Emacs
[https://github.com/carp-lang/carp-emacs](https://github.com/carp-lang/carp-emacs)

# Atom
## Atom
[language-carp](https://atom.io/packages/language-carp) offers highlight with both TextMate and Tree-sitter, where tree-sitter grammar is more powerful.

## Other editors
Expand Down

0 comments on commit 5d23388

Please sign in to comment.