aboutsummaryrefslogtreecommitdiff
path: root/docs/dev/README.md
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-07-10 16:23:18 +0800
committer魏曹先生 <1992414357@qq.com>2026-07-10 16:26:13 +0800
commitabbabd9c55daa79b07cd9ba81037568958794a91 (patch)
tree6bed622d2b500473669f64d6b73c75ba51668946 /docs/dev/README.md
parent73d0f0185f94a8733dfb5eb538298447ab8977b3 (diff)
chore(docs): rename dev-docs directory to dev
Update sidebar link for remove-r-print-macro to use full description
Diffstat (limited to 'docs/dev/README.md')
-rw-r--r--docs/dev/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md
new file mode 100644
index 0000000..a2eede9
--- /dev/null
+++ b/docs/dev/README.md
@@ -0,0 +1,15 @@
+<h1 align="center">Mingling Dev Docs</h1>
+
+<p align="center">
+ Internal development documentation for the <b>Mingling</b> codebase — design notes, issue discussions, and architectural decisions.
+</p>
+
+This site is separate from the [main helpdoc](https://mingling-rs.github.io/mingling/docs/doc.html). The helpdoc is user-facing: tutorials, feature guides, and how-to content for developers _using_ Mingling to build CLI applications. This dev-docs site is for developers _working on_ Mingling itself — understanding internal mechanisms, tracking unresolved problems, and recording design rationale.
+
+## What's here
+
+- **Issues** — Collected notes on known pain points, unresolved trade-offs, and feature gaps in the current implementation.
+
+## How this is different from GitHub Issues
+
+Mingling is hosted on [GitHub](https://github.com/mingling-rs/mingling), and the [Issues page](https://github.com/mingling-rs/mingling/issues) there is primarily for discussion. In contrast, an issue in this document exists only when it is being planned or actively worked on.