From bafe23f814bbd257ba347a9f4ce111cccf0080b3 Mon Sep 17 00:00:00 2001 From: 魏曹先生 <1992414357@qq.com> Date: Thu, 9 Jul 2026 20:00:41 +0800 Subject: docs: add dev-docs site with dark/light theme support --- docs/dev-docs/README.md | 15 +++ docs/dev-docs/_sidebar.md | 3 + docs/dev-docs/index.html | 161 +++++++++++++++++++++++++++++ docs/dev-docs/issues/.name | 1 + docs/dev-docs/issues/the-mod-pathfinder.md | 5 +- docs/dev-docs/issues/the-shit-time.md | 5 +- 6 files changed, 188 insertions(+), 2 deletions(-) create mode 100644 docs/dev-docs/README.md create mode 100644 docs/dev-docs/_sidebar.md create mode 100644 docs/dev-docs/index.html create mode 100644 docs/dev-docs/issues/.name (limited to 'docs/dev-docs') 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 @@ +

Mingling Dev Docs

+ +

+ Internal development documentation for the Mingling codebase — design notes, issue discussions, and architectural decisions. +

+ +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. diff --git a/docs/dev-docs/_sidebar.md b/docs/dev-docs/_sidebar.md new file mode 100644 index 0000000..76c3649 --- /dev/null +++ b/docs/dev-docs/_sidebar.md @@ -0,0 +1,3 @@ +- [Welcome!](README) +* [The Mod Pathfinder](issues/the-mod-pathfinder) +* [Some Situations Where You'd Be Like "Shit!"](issues/the-shit-time) diff --git a/docs/dev-docs/index.html b/docs/dev-docs/index.html new file mode 100644 index 0000000..c3fd04a --- /dev/null +++ b/docs/dev-docs/index.html @@ -0,0 +1,161 @@ + + + + + + + Mingling Dev Docs + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + diff --git a/docs/dev-docs/issues/.name b/docs/dev-docs/issues/.name new file mode 100644 index 0000000..f99478d --- /dev/null +++ b/docs/dev-docs/issues/.name @@ -0,0 +1 @@ +Issues diff --git a/docs/dev-docs/issues/the-mod-pathfinder.md b/docs/dev-docs/issues/the-mod-pathfinder.md index 5a0a4da..5f8c902 100644 --- a/docs/dev-docs/issues/the-mod-pathfinder.md +++ b/docs/dev-docs/issues/the-mod-pathfinder.md @@ -1,4 +1,7 @@ -# The Mod Pathfinder +

The Mod Pathfinder

+

+ A build-time analyzer that computes full module paths for Mingling types, resolving path ambiguity in macros. +

## Background diff --git a/docs/dev-docs/issues/the-shit-time.md b/docs/dev-docs/issues/the-shit-time.md index f830477..77a8af9 100644 --- a/docs/dev-docs/issues/the-shit-time.md +++ b/docs/dev-docs/issues/the-shit-time.md @@ -1,4 +1,7 @@ -# Some Situations Where You'd Be Like "Shit!" +

Some Situations Where You'd Be Like "Shit!"

+

+ This document collects the discomforts currently experienced while using Mingling. +

This document collects the discomforts currently experienced while using Mingling. -- cgit