From 30cb20434a6b117e007a4959b2a7c16489f86069 Mon Sep 17 00:00:00 2001 From: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com> Date: Fri, 4 Sep 2020 08:17:15 -0700 Subject: [PATCH] Mark spec files as archived (#40373) * Mark spec files as archived Maybe then people won't try to edit them and submit PRs * update README --- Gulpfile.js | 2 +- doc/README.md | 8 ++++---- ...e Specification (Change Markup) - ARCHIVED.docx} | Bin ...ge Specification (Change Markup) - ARCHIVED.pdf} | Bin ...peScript Language Specification - ARCHIVED.docx} | Bin ...ypeScript Language Specification - ARCHIVED.pdf} | Bin doc/{spec.md => spec-ARCHIVED.md} | 0 7 files changed, 5 insertions(+), 5 deletions(-) rename doc/{TypeScript Language Specification (Change Markup).docx => TypeScript Language Specification (Change Markup) - ARCHIVED.docx} (100%) rename doc/{TypeScript Language Specification (Change Markup).pdf => TypeScript Language Specification (Change Markup) - ARCHIVED.pdf} (100%) rename doc/{TypeScript Language Specification.docx => TypeScript Language Specification - ARCHIVED.docx} (100%) rename doc/{TypeScript Language Specification.pdf => TypeScript Language Specification - ARCHIVED.pdf} (100%) rename doc/{spec.md => spec-ARCHIVED.md} (100%) diff --git a/Gulpfile.js b/Gulpfile.js index 7bd32515ba..424f769a8c 100644 --- a/Gulpfile.js +++ b/Gulpfile.js @@ -591,7 +591,7 @@ task("LKG").flags = { " --built": "Compile using the built version of the compiler.", }; -const generateSpec = () => exec("cscript", ["//nologo", "scripts/word2md.js", path.resolve("doc/TypeScript Language Specification.docx"), path.resolve("doc/spec.md")]); +const generateSpec = () => exec("cscript", ["//nologo", "scripts/word2md.js", path.resolve("doc/TypeScript Language Specification - ARCHIVED.docx"), path.resolve("doc/spec-ARCHIVED.md")]); task("generate-spec", series(buildScripts, generateSpec)); task("generate-spec").description = "Generates a Markdown version of the Language Specification"; diff --git a/doc/README.md b/doc/README.md index cfc97fedbe..c81a96f7ca 100644 --- a/doc/README.md +++ b/doc/README.md @@ -3,7 +3,7 @@ This directory contains miscellaneous documentation such as the TypeScript language specification and logo. If you are looking for more introductory material, you might want to take a look at the [TypeScript Handbook](https://github.com/Microsoft/TypeScript-Handbook). -# Spec Contributions - -The specification is first authored as a Microsoft Word (docx) file and then generated into Markdown and PDF formats. -Due to the binary format of docx files, and the merging difficulties that may come with it, it is preferred that **any suggestions or problems found in the spec should be [filed as issues](https://github.com/Microsoft/TypeScript/issues/new)** rather than sent as pull requests. + +# Archived Spec + +NOTE: the files in this directory are NOT meant to be edited. They are a snapshot of the out-of-date specification which is no longer being updated. We will not be accepting changes to these documents. diff --git a/doc/TypeScript Language Specification (Change Markup).docx b/doc/TypeScript Language Specification (Change Markup) - ARCHIVED.docx similarity index 100% rename from doc/TypeScript Language Specification (Change Markup).docx rename to doc/TypeScript Language Specification (Change Markup) - ARCHIVED.docx diff --git a/doc/TypeScript Language Specification (Change Markup).pdf b/doc/TypeScript Language Specification (Change Markup) - ARCHIVED.pdf similarity index 100% rename from doc/TypeScript Language Specification (Change Markup).pdf rename to doc/TypeScript Language Specification (Change Markup) - ARCHIVED.pdf diff --git a/doc/TypeScript Language Specification.docx b/doc/TypeScript Language Specification - ARCHIVED.docx similarity index 100% rename from doc/TypeScript Language Specification.docx rename to doc/TypeScript Language Specification - ARCHIVED.docx diff --git a/doc/TypeScript Language Specification.pdf b/doc/TypeScript Language Specification - ARCHIVED.pdf similarity index 100% rename from doc/TypeScript Language Specification.pdf rename to doc/TypeScript Language Specification - ARCHIVED.pdf diff --git a/doc/spec.md b/doc/spec-ARCHIVED.md similarity index 100% rename from doc/spec.md rename to doc/spec-ARCHIVED.md