From 5d2338824bcaed09556ca4d6d638f12de19b7716 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20D=C3=A9v=C3=A9?= Date: Thu, 21 Apr 2022 11:45:26 +0100 Subject: [PATCH] docs: Updates markdown docs to only have one h1 (#1418) --- docs/DynamicSemantics.md | 2 -- docs/ReleaseChecklist.md | 12 ++++++------ docs/Tooling.md | 2 +- 3 files changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/DynamicSemantics.md b/docs/DynamicSemantics.md index e52b371ad..1cba8765c 100644 --- a/docs/DynamicSemantics.md +++ b/docs/DynamicSemantics.md @@ -25,8 +25,6 @@ This document will help us rewrite Carp's dynamic evaluator (defined in Eval.hs)
-# Semantics - ## Index [TODO] diff --git a/docs/ReleaseChecklist.md b/docs/ReleaseChecklist.md index 13fc679ca..468106b21 100644 --- a/docs/ReleaseChecklist.md +++ b/docs/ReleaseChecklist.md @@ -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 diff --git a/docs/Tooling.md b/docs/Tooling.md index 38f00ce0d..181d1d355 100644 --- a/docs/Tooling.md +++ b/docs/Tooling.md @@ -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