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
This site is the canonical documentation home for official nold-ai module bundles hosted in `specfact-cli-modules`.
10
+
This site is the canonical published home for official bundle and module-specific deep documentation.
11
11
12
-
## Bundle guides
12
+
specfact-cli-modules owns the official bundle and module-specific deep guidance, while the core CLI platform docs remain separately owned by the core docs site.
Until Cloudflare routing is enabled for the modules domain, GitHub Pages should be treated as a preview origin rather than the long-term canonical public address.
28
21
29
-
## Docs ownership
22
+
## Official module guides
30
23
31
-
- Bundle/module docs are maintained in this repository.
32
-
- Core CLI platform docs remain in `nold-ai/specfact-cli`.
33
-
- Published URL target: `https://nold-ai.github.io/specfact-cli-modules/`.
- Impact Level: Medium (public docs identity and cross-site navigation change)
12
+
- Validation Result: Pass
13
+
- User Decision: Proceed with dedicated modules docs publication contract
14
+
15
+
## Breaking Changes Detected
16
+
17
+
None at runtime. This is documentation-site and publication-contract work only.
18
+
19
+
The main risk is public-link churn if the site starts claiming a first-class public domain before DNS/routing is available. That is mitigated by keeping wording domain-ready rather than claiming the cutover is already live until Cloudflare configuration exists.
20
+
21
+
## Dependencies Affected
22
+
23
+
### Critical Alignment Dependencies
24
+
25
+
-`README.md` still treats the GitHub Pages project URL as the docs target.
26
+
-`docs/_config.yml` still targets `https://nold-ai.github.io` with `baseurl: "/specfact-cli-modules"`.
27
+
-`docs/index.md` already claims canonical ownership for official module docs, but the surrounding site identity and navigation do not yet match that claim.
28
+
-`docs/_layouts/default.html` still uses the same top navigation structure as the core docs set and will need explicit cross-site labels (`Docs Home`, `Core CLI`, `Modules`).
29
+
30
+
### Cross-Repository Dependencies
31
+
32
+
-`specfact-cli` must update its docs portal and ownership language so module-specific deep pages in core become handoff/overview content rather than competing canonicals.
33
+
- Cloudflare/public-domain setup is required for final publication on `modules.docs.specfact.io`, but content and navigation alignment can land before that cutover.
34
+
35
+
## Impact Assessment
36
+
37
+
-**Code Impact**: None expected
38
+
-**Docs Impact**: Medium-to-high; site config, landing copy, and shared navigation are all in scope
39
+
-**Test Impact**: Lightweight docs assertions are appropriate for site identity, top-nav labels, and canonical ownership wording
40
+
-**Release Impact**: Low-to-medium; the main risk is publishing mixed signals about canonical URLs during the transition window
- Inventory of duplicated docs paths found `86` files shared between `specfact-cli-modules/docs` and `specfact-cli/docs`.
6
+
- The canonical module-owned destinations for this change were documented in `design.md`: landing/config/layout plus module-specific guides, adapter workflows, publishing/signing, and module reference pages.
7
+
- Public-domain cutover assumptions were documented in `design.md`: `docs.specfact.io` remains the entry point and core docs origin, and `modules.specfact.io` becomes the canonical modules origin once GitHub Pages and Cloudflare routing are enabled.
8
+
9
+
## Red Phase
10
+
11
+
Command:
12
+
13
+
```bash
14
+
hatch run pytest tests/unit/test_modules_docs_site_contract.py -q
15
+
```
16
+
17
+
Result:
18
+
19
+
-`4` tests collected
20
+
-`4` failed
21
+
- Failures covered the expected gaps:
22
+
-`_config.yml` still targeted the GitHub Pages project URL instead of the modules public domain contract
23
+
-`docs/index.md` did not yet state canonical ownership for module-specific deep guidance
24
+
-`docs/_layouts/default.html` did not expose `Docs Home`, `Core CLI`, and `Modules`
25
+
- the sidebar remained broad/core-oriented instead of module-focused
26
+
27
+
## Green Phase
28
+
29
+
Command:
30
+
31
+
```bash
32
+
hatch run pytest tests/unit/test_modules_docs_site_contract.py -q
0 commit comments