From cc9065d0e73f63c7cbfa1d5abf86ba0cba8da62a Mon Sep 17 00:00:00 2001 From: moreal Date: Mon, 30 Sep 2024 23:36:22 +0900 Subject: [PATCH 1/2] Write contributing/documentation parts --- docs/contributing/documentation/deployment.md | 9 +++++++++ docs/contributing/documentation/structure.md | 9 +++++++++ docs/contributing/documentation/toc.yml | 5 +++++ docs/contributing/toc.yml | 4 ++++ docs/docfx.json | 4 +++- docs/toc.yml | 4 +++- 6 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 docs/contributing/documentation/deployment.md create mode 100644 docs/contributing/documentation/structure.md create mode 100644 docs/contributing/documentation/toc.yml create mode 100644 docs/contributing/toc.yml diff --git a/docs/contributing/documentation/deployment.md b/docs/contributing/documentation/deployment.md new file mode 100644 index 0000000000..56830a0ef8 --- /dev/null +++ b/docs/contributing/documentation/deployment.md @@ -0,0 +1,9 @@ +# Deployment + +Lib9c automatically deploys documents with GitHub Actions. + +Documents are published to `` (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/`. + +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 new file mode 100644 index 0000000000..3942bea6e1 --- /dev/null +++ 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 new file mode 100644 index 0000000000..79b030518f --- /dev/null +++ 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 new file mode 100644 index 0000000000..6803f3550c --- /dev/null +++ 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 index d7ed402156..96364f3d87 100644 --- 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/toc.yml b/docs/toc.yml index d550025e7b..f24817f12d 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -1,4 +1,6 @@ - name: Docs href: articles/ - name: API - href: api/ \ No newline at end of file + href: api/ +- name: Contributing + href: contributing/ From 03eab32500cfc4899974ef6a30fa645e5081515e Mon Sep 17 00:00:00 2001 From: moreal Date: Mon, 30 Sep 2024 23:37:26 +0900 Subject: [PATCH 2/2] Replace docs homepage with lib9c README --- docs/index.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/docs/index.md b/docs/index.md index 6023cdd385..08844e877d 100644 --- 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. \ No newline at end of file +[!include[README](../README.md)]