diff options
Diffstat (limited to 'docs/dev/README.md')
| -rw-r--r-- | docs/dev/README.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index a2eede9..9289fcf 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md @@ -4,7 +4,11 @@ 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. +This site is separate from the [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 @@ -12,4 +16,6 @@ This site is separate from the [main helpdoc](https://mingling-rs.github.io/ming ## 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. +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. |