diff options
| author | 魏曹先生 <1992414357@qq.com> | 2026-07-09 20:00:41 +0800 |
|---|---|---|
| committer | 魏曹先生 <1992414357@qq.com> | 2026-07-09 20:57:23 +0800 |
| commit | bafe23f814bbd257ba347a9f4ce111cccf0080b3 (patch) | |
| tree | d142ddf8dc7fd8794f48d24b94d2d6157c2771db /docs/dev-docs/README.md | |
| parent | 1d85b4861a3a8e6da264dac122eee908194ce5cf (diff) | |
docs: add dev-docs site with dark/light theme support
Diffstat (limited to 'docs/dev-docs/README.md')
| -rw-r--r-- | docs/dev-docs/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/dev-docs/README.md b/docs/dev-docs/README.md new file mode 100644 index 0000000..a2eede9 --- /dev/null +++ b/docs/dev-docs/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. |
