Merge pull request #2868 from moreal/docs-readme

Write documents about documentation
planetarium · Oct 1, 2024 · ebf3d8a · ebf3d8a
2 parents 7f30ba9 + 03eab32
commit ebf3d8a
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 13 deletions.
diff --git a/docs/contributing/documentation/deployment.md b/docs/contributing/documentation/deployment.md
@@ -0,0 +1,9 @@
+# Deployment
+
+Lib9c automatically deploys documents with GitHub Actions.
+
+Documents are published to `<ref>` (e.g., `development`, `1.18.0`, etc) directory in `gh-pages` branch. when tags or branches are pushed. But tags or branches, starting with `v` are ignored because they are already reserved for other purpose.
+
+After documents were published, you can see your docs at `https://lib9c.nine-chronicles.dev/<ref>`.
+
+For details, you can see [`publish-docs` workflow](https://github.com/planetarium/lib9c/blob/development/.github/workflows/publish-docs.yml)
diff --git a/docs/contributing/documentation/structure.md b/docs/contributing/documentation/structure.md
@@ -0,0 +1,9 @@
+# Structure
+
+Lib9c document has following structures:
+
+```
+api/           <-- Auto-generated .NET APIs
+articles/      <-- Documents about Lib9c behavior
+contributing/  <-- Documents for Lib9c contributors
+```
diff --git a/docs/contributing/documentation/toc.yml b/docs/contributing/documentation/toc.yml
@@ -0,0 +1,5 @@
+items:
+  - name: Structure
+    href: structure.md
+  - name: Deployment
+    href: deployment.md
diff --git a/docs/contributing/toc.yml b/docs/contributing/toc.yml
@@ -0,0 +1,4 @@
+# See https://dotnet.github.io/docfx/docs/table-of-contents.html
+- name: Documentation
+  href: documentation/toc.yml
+  expanded: true
diff --git a/docs/docfx.json b/docs/docfx.json
@@ -29,7 +29,9 @@
           "toc.yml",
           "*.md",
           "articles/**.md",
-          "articles/**/toc.yml"
+          "articles/**/toc.yml",
+          "contributing/**.md",
+          "contributing/**/toc.yml"
         ],
         "exclude": [
           "README.md"

diff --git a/docs/index.md b/docs/index.md
@@ -1,11 +1 @@
----
-_layout: landing
----
-
-# This is the **HOMEPAGE**.
-
-Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
-
-## Quick Start Notes:
-
-1. Add images to the *images* folder if the file is referencing an image.
+[!include[README](../README.md)]
diff --git a/docs/toc.yml b/docs/toc.yml
@@ -1,4 +1,6 @@
 - name: Docs
   href: articles/
 - name: API
-  href: api/
+  href: api/
+- name: Contributing
+  href: contributing/