You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -14,13 +14,16 @@ The project MUST present itself through distinct entry surfaces so that each one
14
14
#### Scenario: New visitor lands on the repository or project site
15
15
-**WHEN** a user opens `README.md` or the GitHub Pages site
16
16
-**THEN** the repository MUST provide a concise explanation of the project's value, core technical highlights, and clear navigation to deeper documentation without mirroring the same long-form content across both surfaces
17
+
-**AND** the Pages home experience MUST behave as the long-form whitepaper entry point rather than as a second copy of the README
18
+
-**AND** the Pages home experience MUST emphasize project thesis, architectural differentiation, and evidence framing before deep implementation detail
17
19
18
20
### Requirement: Documentation inventory is intentionally consolidated
19
21
The project MUST aggressively merge or remove stale, low-value, or overlapping documentation so that each retained document has a single clear responsibility.
-**WHEN** a maintainer reviews root docs, Pages content, and supporting documentation
23
25
-**THEN** duplicate release-history material, overlapping landing pages, and non-authoritative explanatory files MUST be merged or removed until each retained document has a clear purpose and ownership
26
+
-**AND** the public Pages structure MUST avoid parallel sections that explain the same concept with only cosmetic differences
The public repository metadata MUST reinforce the same positioning used by the cleaned documentation and Pages experience.
@@ -37,6 +40,7 @@ The repository MUST provide clear entry points for both English and Chinese read
37
40
-**THEN** the repository MUST present `README.md` as the default English entry
38
41
-**AND** the repository MUST show a prominent link to `README.zh-CN.md` for Chinese readers
39
42
-**AND** both files MUST have consistent structure and navigation tables
43
+
-**AND** both files MUST link to equivalent English and Chinese documentation routes on the published site
40
44
41
45
### Requirement: All public pages offer language switching
42
46
Every public documentation page MUST provide a way to switch to its counterpart in the other language.
@@ -52,11 +56,12 @@ Every public documentation page MUST provide a way to switch to its counterpart
52
56
-**AND** buttons MUST be large enough for touch interaction
53
57
54
58
### Requirement: Tutorial pages have mirrored counterparts
55
-
Every tutorial page in English MUST have a Chinese counterpart with equivalent content structure.
59
+
Every public academy or tutorial page in English MUST have a Chinese counterpart with equivalent content structure.
56
60
57
-
#### Scenario: Tutorial Pages Stay Mirrored
58
-
-**WHEN** a tutorial page exists in English at `/docs/kernel-naive/` with a Chinese counterpart at `/zh/docs/kernel-naive/`
59
-
-**THEN** both pages MUST have equivalent technical content
61
+
#### Scenario: Academy Pages Stay Mirrored
62
+
-**WHEN** a public learning or deep-dive page exists in English under the published documentation tree
63
+
-**THEN** a Chinese counterpart MUST exist at the mirrored route
64
+
-**AND** both pages MUST have equivalent technical content structure
60
65
-**AND** both pages MUST have cross-references to the same related pages
61
66
-**AND** both pages MUST have matching front matter except for language-pair metadata
62
67
@@ -76,3 +81,39 @@ All linked public content MUST resolve correctly with no missing counterparts.
76
81
-**THEN** every linked public page MUST exist
77
82
-**AND** no page MUST reference a missing counterpart
78
83
-**AND** all cross-references MUST resolve correctly
84
+
-**AND** every linked English public route that belongs to the mirrored documentation tree MUST have a Chinese counterpart and vice versa
85
+
86
+
### Requirement: Public whitepaper information architecture is curated by reader depth
87
+
The GitHub Pages site MUST present the project through a mirrored bilingual information architecture that guides readers from orientation to deep technical study instead of exposing an unstructured set of topical pages.
88
+
89
+
#### Scenario: Reader lands on the home page without repository context
90
+
-**WHEN** a visitor opens the English or Chinese home page
91
+
-**THEN** the page MUST summarize the project thesis, the optimization ladder, and the validation model
92
+
-**AND** the page MUST provide direct paths into deeper architecture, academy, validation, and research sections
93
+
94
+
#### Scenario: Reader follows the intended learning path
95
+
-**WHEN** a visitor uses top-level navigation or homepage entry cards
96
+
-**THEN** the documentation structure MUST separate high-level orientation from deep kernel-study pages
97
+
-**AND** the route groups MUST be mirrored between English and Chinese
98
+
99
+
### Requirement: Technical figures remain legible across themes
100
+
All high-signal public technical figures MUST remain readable, visually coherent, and semantically equivalent in both light mode and dark mode.
101
+
102
+
#### Scenario: Visitor switches between light and dark mode
103
+
-**WHEN** the site theme changes
104
+
-**THEN** diagrams, SVG illustrations, icons, and figure labels MUST preserve sufficient contrast for text, boundaries, and emphasis
105
+
-**AND** no critical visual element MUST become effectively invisible in either theme
106
+
107
+
#### Scenario: Architecture page uses a custom figure
108
+
-**WHEN** a page renders a curated architecture or flow figure
109
+
-**THEN** the figure MUST use the site’s shared visual tokens or paired theme-safe assets
110
+
-**AND** the figure MUST remain understandable without relying on a theme-specific background assumption
111
+
112
+
### Requirement: Public research context is explicit and traceable
113
+
The documentation site MUST provide academic-style context that links project claims to references, related open-source implementations, and architectural evolution notes.
0 commit comments