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
This commit is contained in:
parent
d5a646eb66
commit
30cb20434a
|
@ -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";
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
|
Loading…
Reference in a new issue