chore(docs): move docs to their own folder

- Moved all of the docs, except for the README and LICENSE to their own folder so that the root of the repo doesn't end up cluttered. - Added a link in the README to the Thrift website. - Fixed a problem where Prettier had removed the `#` from `C#` in a header. I've ended up using the HTML code instead to stop markdownlint complaining about having a `#` symbol in a header, and added a temporary ignore to stop it complaining about the trailing `;`. Part of #44
adamconnelly · Oct 9, 2020 · 24203f0 · 24203f0
1 parent 5489407
commit 24203f0
Show file tree

Hide file tree

Showing 9 changed files with 11 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # Thrift.Net
 
-The aim of the Thrift.Net project is to create an implementation of the Thrift
-compiler and runtime library in C#, providing a first class experience for .NET
-developers wanting to use Thrift.
+The aim of the Thrift.Net project is to create an implementation of the
+[Thrift](https://thrift.apache.org/) compiler and runtime library in C#,
+providing a first class experience for .NET developers wanting to use Thrift.
 
 ## License
 
@@ -18,10 +18,10 @@ Once we have a working compiler, the next step will be to implement the runtime
 library to make Thrift.Net self contained.
 
 For information about the initial design goals for the project, see the
-[design goals](design-goals.md) page. For information on the project roadmap,
-see the [roadmap page](roadmap.md).
+[design goals](docs/design-goals.md) page. For information on the project
+roadmap, see the [roadmap page](docs/roadmap.md).
 
 ## Contributing
 
 If you want to contribute to the development of Thrift.Net, please see our
-[contribution guide](CONTRIBUTING.md).
+[contribution guide](docs/CONTRIBUTING.md).
diff --git a/Antlr-Debug-Example.png → docs/Antlr-Debug-Example.png b/Antlr-Debug-Example.png → docs/Antlr-Debug-Example.png
diff --git a/CONTRIBUTING.md → docs/CONTRIBUTING.md b/CONTRIBUTING.md → docs/CONTRIBUTING.md
@@ -156,7 +156,11 @@ These guides explain how to work on particular parts of the code base:
 
 ## Code Style
 
-### C\
+<!-- markdownlint-disable MD026 -->
+
+### C&#35;
+
+<!-- markdownlint-enable MD026 -->
 
 We use [StyleCop](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) to make
 sure our C# code conforms to a common standard, and is well documented. StyleCop

diff --git a/add-new-compiler-messages.md → docs/add-new-compiler-messages.md b/add-new-compiler-messages.md → docs/add-new-compiler-messages.md
diff --git a/add-new-syntax-to-compiler.md → docs/add-new-syntax-to-compiler.md b/add-new-syntax-to-compiler.md → docs/add-new-syntax-to-compiler.md
diff --git a/binding.md → docs/binding.md b/binding.md → docs/binding.md
diff --git a/compilation.md → docs/compilation.md b/compilation.md → docs/compilation.md
diff --git a/design-goals.md → docs/design-goals.md b/design-goals.md → docs/design-goals.md
diff --git a/roadmap.md → docs/roadmap.md b/roadmap.md → docs/roadmap.md