From 5dee1fe78cfe50d5b4efd57cadd4f07c2c14b000 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sun, 4 Dec 2022 11:22:05 -0800 Subject: [PATCH] ;doc: move most dev docs to doc/ --- Shake.hs | 12 ++++++------ ACHIEVEMENTS.md => doc/ACHIEVEMENTS.md | 0 BACKLOG.org => doc/BACKLOG.org | 0 BENCHMARKS.md => doc/BENCHMARKS.md | 0 CHANGELOGS.md => doc/CHANGELOGS.md | 0 CODE.md => doc/CODE.md | 0 COMMITS.md => doc/COMMITS.md | 0 CONTRIBUTING.md => doc/CONTRIBUTING.md | 0 CREDITS.md => doc/CREDITS.md | 0 DOCS.md => doc/DOCS.md | 0 EXAMPLES.md => doc/EXAMPLES.md | 0 FINANCE.md => doc/FINANCE.md | 0 ISSUES.md => doc/ISSUES.md | 0 LINKS.md => doc/LINKS.md | 0 MAKE.md => doc/MAKE.md | 0 PULLREQUESTS.md => doc/PULLREQUESTS.md | 0 RELEASING.md => doc/RELEASING.md | 0 ROADMAP.org => doc/ROADMAP.org | 0 SHAKE.md => doc/SHAKE.md | 0 TESTS.md => doc/TESTS.md | 0 VERSIONNUMBERS.md => doc/VERSIONNUMBERS.md | 0 WORKFLOWS.md => doc/WORKFLOWS.md | 0 22 files changed, 6 insertions(+), 6 deletions(-) rename ACHIEVEMENTS.md => doc/ACHIEVEMENTS.md (100%) rename BACKLOG.org => doc/BACKLOG.org (100%) rename BENCHMARKS.md => doc/BENCHMARKS.md (100%) rename CHANGELOGS.md => doc/CHANGELOGS.md (100%) rename CODE.md => doc/CODE.md (100%) rename COMMITS.md => doc/COMMITS.md (100%) rename CONTRIBUTING.md => doc/CONTRIBUTING.md (100%) rename CREDITS.md => doc/CREDITS.md (100%) rename DOCS.md => doc/DOCS.md (100%) rename EXAMPLES.md => doc/EXAMPLES.md (100%) rename FINANCE.md => doc/FINANCE.md (100%) rename ISSUES.md => doc/ISSUES.md (100%) rename LINKS.md => doc/LINKS.md (100%) rename MAKE.md => doc/MAKE.md (100%) rename PULLREQUESTS.md => doc/PULLREQUESTS.md (100%) rename RELEASING.md => doc/RELEASING.md (100%) rename ROADMAP.org => doc/ROADMAP.org (100%) rename SHAKE.md => doc/SHAKE.md (100%) rename TESTS.md => doc/TESTS.md (100%) rename VERSIONNUMBERS.md => doc/VERSIONNUMBERS.md (100%) rename WORKFLOWS.md => doc/WORKFLOWS.md (100%) diff --git a/Shake.hs b/Shake.hs index b0edffb08..822ca8bd2 100755 --- a/Shake.hs +++ b/Shake.hs @@ -762,18 +762,18 @@ main = do phony "orgfiles" $ need [ - ".BACKLOG.md" - ,".ROADMAP.md" + "doc/BACKLOG.md" + ,"doc/ROADMAP.md" ] -- These org files are converted to markdown for the website. - [ ".ROADMAP.md" - ,".BACKLOG.md" + [ "doc/ROADMAP.md" + ,"doc/BACKLOG.md" ] |%> \out -> do - let src = drop 1 out -<.> "org" + let src = out -<.> "org" need [src] -- replace the generated top heading with our own so we can insert the TOC after it - let heading = dropExtension $ drop 1 out + let heading = dropExtension out mdlines <- drop 1 . lines . fromStdout <$> (cmd Shell pandoc fromorg towebmd src :: Action (Stdout String)) liftIO $ writeFile out $ unlines $ [ "" diff --git a/ACHIEVEMENTS.md b/doc/ACHIEVEMENTS.md similarity index 100% rename from ACHIEVEMENTS.md rename to doc/ACHIEVEMENTS.md diff --git a/BACKLOG.org b/doc/BACKLOG.org similarity index 100% rename from BACKLOG.org rename to doc/BACKLOG.org diff --git a/BENCHMARKS.md b/doc/BENCHMARKS.md similarity index 100% rename from BENCHMARKS.md rename to doc/BENCHMARKS.md diff --git a/CHANGELOGS.md b/doc/CHANGELOGS.md similarity index 100% rename from CHANGELOGS.md rename to doc/CHANGELOGS.md diff --git a/CODE.md b/doc/CODE.md similarity index 100% rename from CODE.md rename to doc/CODE.md diff --git a/COMMITS.md b/doc/COMMITS.md similarity index 100% rename from COMMITS.md rename to doc/COMMITS.md diff --git a/CONTRIBUTING.md b/doc/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to doc/CONTRIBUTING.md diff --git a/CREDITS.md b/doc/CREDITS.md similarity index 100% rename from CREDITS.md rename to doc/CREDITS.md diff --git a/DOCS.md b/doc/DOCS.md similarity index 100% rename from DOCS.md rename to doc/DOCS.md diff --git a/EXAMPLES.md b/doc/EXAMPLES.md similarity index 100% rename from EXAMPLES.md rename to doc/EXAMPLES.md diff --git a/FINANCE.md b/doc/FINANCE.md similarity index 100% rename from FINANCE.md rename to doc/FINANCE.md diff --git a/ISSUES.md b/doc/ISSUES.md similarity index 100% rename from ISSUES.md rename to doc/ISSUES.md diff --git a/LINKS.md b/doc/LINKS.md similarity index 100% rename from LINKS.md rename to doc/LINKS.md diff --git a/MAKE.md b/doc/MAKE.md similarity index 100% rename from MAKE.md rename to doc/MAKE.md diff --git a/PULLREQUESTS.md b/doc/PULLREQUESTS.md similarity index 100% rename from PULLREQUESTS.md rename to doc/PULLREQUESTS.md diff --git a/RELEASING.md b/doc/RELEASING.md similarity index 100% rename from RELEASING.md rename to doc/RELEASING.md diff --git a/ROADMAP.org b/doc/ROADMAP.org similarity index 100% rename from ROADMAP.org rename to doc/ROADMAP.org diff --git a/SHAKE.md b/doc/SHAKE.md similarity index 100% rename from SHAKE.md rename to doc/SHAKE.md diff --git a/TESTS.md b/doc/TESTS.md similarity index 100% rename from TESTS.md rename to doc/TESTS.md diff --git a/VERSIONNUMBERS.md b/doc/VERSIONNUMBERS.md similarity index 100% rename from VERSIONNUMBERS.md rename to doc/VERSIONNUMBERS.md diff --git a/WORKFLOWS.md b/doc/WORKFLOWS.md similarity index 100% rename from WORKFLOWS.md rename to doc/WORKFLOWS.md