Fix some not reported issues

NoiseStudio · Jan 24, 2024 · b28508e · b28508e
1 parent f3cae4b
commit b28508e
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -31,9 +31,9 @@ Our golden goal is to create the most performant engine, one which enables game
 > [!IMPORTANT] 
 > Currently (before v0.1.0) initial documentation is still being writen. It is not published on any website.
 
-You can find information in [docs directory](/docs/README.md) which also have manual. Or see [examples directory](/examples/README.md) to see how it looks in code.
+You can find information in [docs directory](/docs/) which also have manual. Or see [examples directory](/examples/) to see how it looks in code.
 
-And do not forget to read about API from [documentation comments](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments). Also you can find another usage examples in [tests](/docs/project-structure.md).
+And do not forget to read about API from [documentation comments](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments). Also you can find another usage examples in [tests](/docs/internal/project-structure.md).
 
 ### Project structure
 We have a few repositories which contain parts of the entire project:

diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,20 @@
+# Docs of NoiseEngine
+Welcome to NoiseEngine docs!
+
+## Sections
+
+<div class="link-panel">
+    <a href="manual/">
+        <img src="../images/docs/manual/get-started/create-new-project/primitives.webp">
+        <h3>Manual</h3>
+    </a>
+    <p>Manual which describes how to use NoiseEngine</p>
+</div>
+
+<div class="link-panel">
+    <a href="internal/">
+        <img src="../images/voxel-terrain.webp">
+        <h3>Internal</h3>
+    </a>
+    <p>NoiseEnginet's architecture description</p>
+</div>
diff --git a/docs/manual/get-started/create-new-project.md b/docs/manual/get-started/create-new-project.md
@@ -85,4 +85,4 @@ And now, after running application we should see:
 If you do not see it, probably you are rotated wrong, move your mouse fast and find a cube.
 
 ### Source code
-You can find source code of this and another examples [here](/examples/manual/get-started/create-new-project/README.md).
+You can find source code of this and another examples [here](/examples/manual/get-started/create-new-project/).
diff --git a/docs/manual/internal/README.md b/docs/manual/internal/README.md
@@ -0,0 +1,2 @@
+# Internal
+NoiseEnginet's architecture description
diff --git a/docs/project-structure.md → docs/manual/internal/project-structure.md b/docs/project-structure.md → docs/manual/internal/project-structure.md