chore: docs

YieldLang · May 11, 2024 · 6ac6fd4 · 6ac6fd4
1 parent de103ea
commit 6ac6fd4
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@
 
 ## [Read the docs](https://docs.yieldlang.com/)
 
-YieldLang is a [meta-language](https://en.wikipedia.org/wiki/Metalanguage) for generating structured text (ST) that can provide corpora for large language models (LLMs) or guide LLMs to generate ST. Currently provided as a Python package.
+YieldLang is a [meta-language](https://en.wikipedia.org/wiki/Metalanguage) for generating structured text (ST) that can provide corpora for large language models (LLMs) or guide LLMs to generate ST. Currently provided as a [Python package](https://pypi.org/project/yieldlang/).
 
 - 🧠 Based on a coroutine generator and sampler architecture
 - 🤖 Stream-sends characters and parses the context above into a syntax tree
@@ -149,16 +149,14 @@ make docs       # Build and watch the docs
 
 ### Release
 
-Release the YieldLang package.
+Release the YieldLang package. Visit: [RELEASE_PROCESS.md](./RELEASE_PROCESS.md)
 
-- Visit: [RELEASE_PROCESS.md](./RELEASE_PROCESS.md)
-
-## Acknowledgements
+## Publications
 
-- Python package template at [github.com/allenai/python-package-template](https://github.com/allenai/python-package-template)
+- [Guiding Large Language Models to Generate Computer-Parsable Content](https://arxiv.org/abs/2404.05499)  
+  Author: [Jiaye Wang](https://orcid.org/0009-0007-5832-2474) Date: `2024-03-26 22:54:14`
 
 
-## Publications
+## Acknowledgements
 
-- [Guiding Large Language Models to Generate Computer-Parsable Content](https://arxiv.org/abs/2404.05499)  
-  Author: [Jiaye Wang](https://orcid.org/0009-0007-5832-2474) Date: `2024-03-26 22:54:14`
+- Python package template at [github.com/allenai/python-package-template](https://github.com/allenai/python-package-template)
diff --git a/README.zh-hans.md b/README.zh-hans.md
@@ -16,7 +16,7 @@
 
 ## [阅读官方文档](https://docs.yieldlang.com/)
 
-YieldLang 是一个生成结构化文本 (ST) 的[元语言](https://en.wikipedia.org/wiki/Metalanguage)，它可以为大语言模型 (LLM) 提供语料或引导 LLM 生成 ST 。目前以 Python 软件包的方式提供。
+YieldLang 是一个生成结构化文本 (ST) 的[元语言](https://en.wikipedia.org/wiki/Metalanguage)，它可以为大语言模型 (LLM) 提供语料或引导 LLM 生成 ST 。目前以 [Python 软件包](https://pypi.org/project/yieldlang/)的方式提供。
 
 - 🧠 采用基于协程的生成器、采样器架构
 - 🤖 流式发送字符的并解析上文为语法树
@@ -152,15 +152,14 @@ make docs       # 构建并查看文档
 
 ### Release
 
-发布 YieldLang 软件包。
+发布 YieldLang 软件包。请参考: [RELEASE_PROCESS.md](./RELEASE_PROCESS.md)
 
-- 请参考: [RELEASE_PROCESS.md](./RELEASE_PROCESS.md)
+## Publications
 
-## Acknowledgements
+- [引导大语言模型生成计算机可解析内容](https://arxiv.org/abs/2404.05499)  
+  作者：[王家晔](https://orcid.org/0009-0007-5832-2474) 日期：`2024-03-26 22:54:14`
 
-- Python 软件包参考了模板：[github.com/allenai/python-package-template](https://github.com/allenai/python-package-template)
 
-## Publications
+## Acknowledgements
 
-- [引导大语言模型生成计算机可解析内容](https://arxiv.org/abs/2404.05499)  
-  作者：[王家晔](https://orcid.org/0009-0007-5832-2474) 日期：`2024-03-26 22:54:14`
+- Python 软件包参考了模板：[github.com/allenai/python-package-template](https://github.com/allenai/python-package-template)
diff --git a/docs/source/development.md b/docs/source/development.md
@@ -27,9 +27,7 @@ make docs       # Build and watch the docs
 
 ## Release
 
-Release the YieldLang package.
-
-- Visit: [RELEASE_PROCESS.md](./RELEASE_PROCESS.md)
+Release the YieldLang package. Visit: [RELEASE_PROCESS.md](./RELEASE_PROCESS.md)
 
 ## Acknowledgements
 

diff --git a/docs/source/overview.md b/docs/source/overview.md
@@ -3,7 +3,7 @@ Overview
 
 YieldLang is a [meta-language](https://en.wikipedia.org/wiki/Metalanguage) for LLMs to process (produce and parse) structured info.
 
-- View our [publications](publications.md) for more information.
+- View our [publications](publications.md) for more information
 
 ## Simple Usage