aboutsummaryrefslogtreecommitdiff
path: root/docs/dev/README.md
blob: 9289fcf2d4a7473e231deaf6853fc9cd9d99a352 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<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 [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.