aboutsummaryrefslogtreecommitdiff
path: root/docs/dev-docs
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-07-09 20:00:41 +0800
committer魏曹先生 <1992414357@qq.com>2026-07-09 20:57:23 +0800
commitbafe23f814bbd257ba347a9f4ce111cccf0080b3 (patch)
treed142ddf8dc7fd8794f48d24b94d2d6157c2771db /docs/dev-docs
parent1d85b4861a3a8e6da264dac122eee908194ce5cf (diff)
docs: add dev-docs site with dark/light theme support
Diffstat (limited to 'docs/dev-docs')
-rw-r--r--docs/dev-docs/README.md15
-rw-r--r--docs/dev-docs/_sidebar.md3
-rw-r--r--docs/dev-docs/index.html161
-rw-r--r--docs/dev-docs/issues/.name1
-rw-r--r--docs/dev-docs/issues/the-mod-pathfinder.md5
-rw-r--r--docs/dev-docs/issues/the-shit-time.md5
6 files changed, 188 insertions, 2 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.
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 @@
+<!doctype html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta
+ name="viewport"
+ content="width=device-width, initial-scale=1, minimum-scale=1.0, shrink-to-fit=no, viewport-fit=cover"
+ />
+
+ <title>Mingling Dev Docs</title>
+ <meta
+ name="Mingling Dev Docs"
+ content="Internal design docs, issue discussions, and development notes for Mingling."
+ />
+
+ <link rel="preconnect" href="https://fonts.googleapis.com" />
+ <link rel="icon" type="image/png" href="../res/favicon_small.png" />
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+ <link
+ href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;600&display=swap"
+ rel="stylesheet"
+ />
+
+ <link rel="stylesheet" href="../css/dev-light.css" />
+ <link
+ id="dark-style"
+ rel="stylesheet"
+ href="../css/dev-dark.css"
+ disabled
+ />
+
+ <style>
+ /* ── No sidebar header image override ── */
+ .sidebar > h1 .app-name-link {
+ font-family:
+ "JetBrains Mono", "SF Mono", "Fira Code", "Cascadia Code",
+ monospace;
+ font-size: 16px;
+ font-weight: 600;
+ letter-spacing: -0.3px;
+ }
+ .sidebar > h1 .app-name-link::before {
+ content: "⚙ ";
+ font-family:
+ system-ui,
+ -apple-system,
+ sans-serif;
+ letter-spacing: 0;
+ }
+ .markdown-section h1,
+ .markdown-section h2,
+ .markdown-section h3,
+ .markdown-section h4 {
+ font-family:
+ "JetBrains Mono", "SF Mono", "Fira Code", "Cascadia Code",
+ monospace;
+ font-weight: 600;
+ letter-spacing: -0.5px;
+ }
+ .markdown-section h1 {
+ font-size: 24px;
+ }
+ .markdown-section h2 {
+ font-size: 19px;
+ }
+ .markdown-section h3 {
+ font-size: 16px;
+ }
+ .markdown-section p,
+ .markdown-section li {
+ font-family:
+ system-ui,
+ -apple-system,
+ "Segoe UI",
+ "Noto Sans",
+ Helvetica,
+ Arial,
+ sans-serif;
+ }
+ .sidebar ul li a {
+ font-family:
+ "JetBrains Mono", "SF Mono", "Fira Code", "Cascadia Code",
+ monospace;
+ font-size: 13px;
+ letter-spacing: -0.2px;
+ }
+ .sidebar ul li ul li a {
+ font-size: 12px;
+ }
+ /* ── Top nav bar ── */
+ .dev-nav {
+ position: fixed;
+ top: 12px;
+ right: 30px;
+ z-index: 20;
+ display: flex;
+ gap: 4px;
+ align-items: center;
+ }
+ .dev-nav a {
+ font-family:
+ "JetBrains Mono", "SF Mono", "Fira Code", "Cascadia Code",
+ monospace;
+ font-size: 12px;
+ text-transform: uppercase;
+ letter-spacing: 0.5px;
+ color: #656d76;
+ text-decoration: none;
+ padding: 4px 10px;
+ transition: color 0.15s;
+ }
+ .dev-nav a:hover {
+ color: #0969da;
+ }
+ </style>
+ </head>
+
+ <body>
+ <nav class="dev-nav">
+ <a
+ href="#"
+ onclick="
+ toggleTheme();
+ return false;
+ "
+ >🌓 Theme</a
+ >
+ <a href="../doc.html">📖 Helpdoc</a>
+ </nav>
+
+ <div id="app"></div>
+
+ <script>
+ window.$docsify = {
+ name: "dev-docs",
+ repo: "true",
+ corner: {
+ url: "https://github.com/mingling-rs/mingling",
+ icon: "github",
+ },
+ auto2top: true,
+ loadSidebar: true,
+ maxLevel: 0,
+ subMaxLevel: 3,
+ search: {
+ placeholder: "Search dev docs…",
+ noData: "No matches found.",
+ depth: 2,
+ },
+ };
+ </script>
+
+ <script src="../scripts/docsify.min.js"></script>
+ <script src="../scripts/search.js"></script>
+ <script src="../scripts/prism-bash.min.js"></script>
+ <script src="../scripts/prism-toml.min.js"></script>
+ <script src="../scripts/prism-rust.js"></script>
+ <script src="../scripts/docsify-corner.js"></script>
+ <script src="../scripts/day-night-switch.js"></script>
+ </body>
+</html>
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
+<h1 align="center">The Mod Pathfinder</h1>
+<p align="center">
+ A build-time analyzer that computes full module paths for Mingling types, resolving path ambiguity in macros.
+</p>
## 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!"
+<h1 align="center">Some Situations Where You'd Be Like "Shit!"</h1>
+<p align="center">
+ This document collects the discomforts currently experienced while using Mingling.
+</p>
This document collects the discomforts currently experienced while using Mingling.
generated by cgit (git 2.34.1) at 2026-07-10 20:56:04 +0000