@doxbrix/doxloop 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/CHANGELOG.md +34 -0
  2. package/LICENSE +93 -0
  3. package/README.md +576 -0
  4. package/SECURITY.md +15 -0
  5. package/assets/brand/README.md +8 -0
  6. package/assets/brand/doxloop-favicon.png +0 -0
  7. package/assets/brand/doxloop-logo-dark.png +0 -0
  8. package/assets/brand/doxloop-logo-light.png +0 -0
  9. package/assets/doxbrix-preview.css +6672 -0
  10. package/dist/agents.d.ts +26 -0
  11. package/dist/agents.d.ts.map +1 -0
  12. package/dist/agents.js +258 -0
  13. package/dist/agents.js.map +1 -0
  14. package/dist/args.d.ts +8 -0
  15. package/dist/args.d.ts.map +1 -0
  16. package/dist/args.js +95 -0
  17. package/dist/args.js.map +1 -0
  18. package/dist/artifact-deploy.d.ts +8 -0
  19. package/dist/artifact-deploy.d.ts.map +1 -0
  20. package/dist/artifact-deploy.js +240 -0
  21. package/dist/artifact-deploy.js.map +1 -0
  22. package/dist/auth.d.ts +17 -0
  23. package/dist/auth.d.ts.map +1 -0
  24. package/dist/auth.js +245 -0
  25. package/dist/auth.js.map +1 -0
  26. package/dist/author.d.ts +30 -0
  27. package/dist/author.d.ts.map +1 -0
  28. package/dist/author.js +195 -0
  29. package/dist/author.js.map +1 -0
  30. package/dist/capture.d.ts +10 -0
  31. package/dist/capture.d.ts.map +1 -0
  32. package/dist/capture.js +299 -0
  33. package/dist/capture.js.map +1 -0
  34. package/dist/cli.d.ts +3 -0
  35. package/dist/cli.d.ts.map +1 -0
  36. package/dist/cli.js +558 -0
  37. package/dist/cli.js.map +1 -0
  38. package/dist/deploy.d.ts +22 -0
  39. package/dist/deploy.d.ts.map +1 -0
  40. package/dist/deploy.js +136 -0
  41. package/dist/deploy.js.map +1 -0
  42. package/dist/doctor.d.ts +18 -0
  43. package/dist/doctor.d.ts.map +1 -0
  44. package/dist/doctor.js +222 -0
  45. package/dist/doctor.js.map +1 -0
  46. package/dist/doxbrix-markdown.d.ts +20 -0
  47. package/dist/doxbrix-markdown.d.ts.map +1 -0
  48. package/dist/doxbrix-markdown.js +873 -0
  49. package/dist/doxbrix-markdown.js.map +1 -0
  50. package/dist/errors.d.ts +8 -0
  51. package/dist/errors.d.ts.map +1 -0
  52. package/dist/errors.js +15 -0
  53. package/dist/errors.js.map +1 -0
  54. package/dist/fs.d.ts +6 -0
  55. package/dist/fs.d.ts.map +1 -0
  56. package/dist/fs.js +77 -0
  57. package/dist/fs.js.map +1 -0
  58. package/dist/generator-api.d.ts +69 -0
  59. package/dist/generator-api.d.ts.map +1 -0
  60. package/dist/generator-api.js +6 -0
  61. package/dist/generator-api.js.map +1 -0
  62. package/dist/generator-manager.d.ts +13 -0
  63. package/dist/generator-manager.d.ts.map +1 -0
  64. package/dist/generator-manager.js +155 -0
  65. package/dist/generator-manager.js.map +1 -0
  66. package/dist/generator-runtime.d.ts +24 -0
  67. package/dist/generator-runtime.d.ts.map +1 -0
  68. package/dist/generator-runtime.js +265 -0
  69. package/dist/generator-runtime.js.map +1 -0
  70. package/dist/generators.d.ts +21 -0
  71. package/dist/generators.d.ts.map +1 -0
  72. package/dist/generators.js +202 -0
  73. package/dist/generators.js.map +1 -0
  74. package/dist/preview.d.ts +21 -0
  75. package/dist/preview.d.ts.map +1 -0
  76. package/dist/preview.js +691 -0
  77. package/dist/preview.js.map +1 -0
  78. package/dist/progress.d.ts +19 -0
  79. package/dist/progress.d.ts.map +1 -0
  80. package/dist/progress.js +70 -0
  81. package/dist/progress.js.map +1 -0
  82. package/dist/project.d.ts +37 -0
  83. package/dist/project.d.ts.map +1 -0
  84. package/dist/project.js +499 -0
  85. package/dist/project.js.map +1 -0
  86. package/dist/sync.d.ts +7 -0
  87. package/dist/sync.d.ts.map +1 -0
  88. package/dist/sync.js +221 -0
  89. package/dist/sync.js.map +1 -0
  90. package/dist/types.d.ts +141 -0
  91. package/dist/types.d.ts.map +1 -0
  92. package/dist/types.js +2 -0
  93. package/dist/types.js.map +1 -0
  94. package/dist/validation.d.ts +4 -0
  95. package/dist/validation.d.ts.map +1 -0
  96. package/dist/validation.js +478 -0
  97. package/dist/validation.js.map +1 -0
  98. package/dist/version.d.ts +3 -0
  99. package/dist/version.d.ts.map +1 -0
  100. package/dist/version.js +5 -0
  101. package/dist/version.js.map +1 -0
  102. package/docs/agent-compatibility.md +41 -0
  103. package/docs/ci-and-automation.md +56 -0
  104. package/docs/doxbrix-http-api.md +182 -0
  105. package/docs/generator-authoring.md +59 -0
  106. package/docs/generator-selection.md +25 -0
  107. package/docs/project-format.md +97 -0
  108. package/docs/security-model.md +90 -0
  109. package/docs/troubleshooting.md +103 -0
  110. package/package.json +87 -0
  111. package/skills/doxloop-authoring/SKILL.md +381 -0
  112. package/skills/doxloop-authoring/agents/openai.yaml +4 -0
  113. package/skills/doxloop-authoring/assets/screenshot-highlight.js +83 -0
  114. package/skills/doxloop-authoring/references/accessibility.md +54 -0
  115. package/skills/doxloop-authoring/references/audience-flavors.md +93 -0
  116. package/skills/doxloop-authoring/references/branding.md +50 -0
  117. package/skills/doxloop-authoring/references/documentation-types.md +236 -0
  118. package/skills/doxloop-authoring/references/domain-ai-ml.md +67 -0
  119. package/skills/doxloop-authoring/references/domain-api-platform.md +68 -0
  120. package/skills/doxloop-authoring/references/domain-cli-tool.md +65 -0
  121. package/skills/doxloop-authoring/references/domain-data-platform.md +65 -0
  122. package/skills/doxloop-authoring/references/domain-developer-library.md +63 -0
  123. package/skills/doxloop-authoring/references/domain-ecommerce.md +63 -0
  124. package/skills/doxloop-authoring/references/domain-infrastructure-devops.md +67 -0
  125. package/skills/doxloop-authoring/references/domain-payments-fintech.md +69 -0
  126. package/skills/doxloop-authoring/references/domain-saas.md +71 -0
  127. package/skills/doxloop-authoring/references/domain-security-identity.md +65 -0
  128. package/skills/doxloop-authoring/references/editorial-style.md +105 -0
  129. package/skills/doxloop-authoring/references/examples-and-evidence.md +71 -0
  130. package/skills/doxloop-authoring/references/navigation-architecture.md +152 -0
  131. package/skills/doxloop-authoring/references/project-format.md +119 -0
  132. package/skills/doxloop-authoring/references/quality.md +122 -0
  133. package/skills/doxloop-authoring/references/reference-sites.md +207 -0
  134. package/skills/doxloop-authoring/references/screenshots.md +251 -0
  135. package/skills/doxloop-authoring/references/template-routing.md +94 -0
  136. package/skills/doxloop-authoring/references/type-administrator-guide.md +59 -0
  137. package/skills/doxloop-authoring/references/type-api-reference.md +66 -0
  138. package/skills/doxloop-authoring/references/type-architecture-concepts.md +61 -0
  139. package/skills/doxloop-authoring/references/type-cli-manual.md +61 -0
  140. package/skills/doxloop-authoring/references/type-deployment-operations.md +64 -0
  141. package/skills/doxloop-authoring/references/type-developer-portal.md +69 -0
  142. package/skills/doxloop-authoring/references/type-getting-started.md +59 -0
  143. package/skills/doxloop-authoring/references/type-integration-guide.md +59 -0
  144. package/skills/doxloop-authoring/references/type-migration-release.md +66 -0
  145. package/skills/doxloop-authoring/references/type-sdk-guide.md +63 -0
  146. package/skills/doxloop-authoring/references/type-troubleshooting-kb.md +63 -0
  147. package/skills/doxloop-authoring/references/type-user-guide.md +59 -0
  148. package/skills/doxloop-doxbrix/SKILL.md +83 -0
  149. package/skills/doxloop-doxbrix/agents/openai.yaml +4 -0
  150. package/skills/doxloop-doxbrix/references/api-endpoints.md +128 -0
  151. package/skills/doxloop-doxbrix/references/components.md +137 -0
  152. package/skills/doxloop-doxbrix/references/manifest.md +117 -0
@@ -0,0 +1,67 @@
1
+ # Infrastructure and DevOps expertise
2
+
3
+ Use when readers provision, deploy, configure, observe, scale, upgrade, or
4
+ recover infrastructure, platforms, services, clusters, or developer environments.
5
+
6
+ ## Think like a senior platform documentation architect
7
+
8
+ Treat an operational procedure as a controlled state transition. Identify
9
+ dependencies, authority, desired state, blast radius, health signals, rollback,
10
+ and recovery verification. Separate initial deployment, routine operations,
11
+ change management, and incident response.
12
+
13
+ ## Investigate
14
+
15
+ - supported topology, components, dependencies, ports, protocols, and environments;
16
+ - installation artifacts, versions, resource requirements, and platform support;
17
+ - configuration sources, precedence, secrets, reload or restart behavior;
18
+ - provisioning idempotency, state storage, drift, locking, and concurrency;
19
+ - health, readiness, metrics, logs, traces, events, and diagnostic bundles;
20
+ - scaling, capacity signals, quotas, limits, maintenance, and scheduling;
21
+ - upgrades, compatibility, schema or state migration, rollback, and downgrade;
22
+ - backup scope, consistency, retention, restore, disaster recovery, and verification;
23
+ - high availability, failure domains, traffic handling, and degraded states;
24
+ - security boundaries, network access, administrative roles, and audit evidence.
25
+
26
+ ## Design coverage
27
+
28
+ Give a supported reference deployment, then expose decision points rather than
29
+ pretending one topology fits all. Every procedure must include prechecks,
30
+ commands or actions, expected signals, abort conditions, rollback when supported,
31
+ and post-change verification. Put destructive recovery behind explicit warnings.
32
+
33
+ Use runbooks for observable incidents and reference pages for configuration and
34
+ signals. Keep commands deterministic and scope targets explicitly. Distinguish
35
+ development convenience from production guidance.
36
+
37
+ ## Navigation overlay
38
+
39
+ Insert supported destinations following the operating lifecycle:
40
+
41
+ ```text
42
+ Architecture and environments
43
+ Provisioning and installation
44
+ Configuration and secrets
45
+ Deployment and readiness
46
+ Observability
47
+ Scaling and capacity
48
+ Routine maintenance
49
+ Upgrade and rollback
50
+ Backup, restore, and disaster recovery
51
+ Incident diagnostics
52
+ ```
53
+
54
+ Put health verification immediately after deployment and recovery procedures.
55
+
56
+ ## Never assume
57
+
58
+ Do not claim high availability, zero downtime, horizontal scaling, backup
59
+ consistency, restore objectives, rollback safety, autoscaling, resource sizing,
60
+ or production readiness without evidence. A process starting is not sufficient
61
+ health verification.
62
+
63
+ ## Senior quality gate
64
+
65
+ An operator must be able to deploy the supported topology, verify service
66
+ health, understand configuration and failure scope, perform a supported change,
67
+ and recover or escalate using observable evidence rather than guesswork.
@@ -0,0 +1,69 @@
1
+ # Payments and fintech expertise
2
+
3
+ Use when the public product moves, authorizes, records, settles, reconciles, or
4
+ reports money or other regulated financial value. Pair with the API-platform,
5
+ SaaS, or infrastructure template when appropriate.
6
+
7
+ ## Think like a senior payments documentation lead
8
+
9
+ Document money movement as an explicit state machine with actors, amounts,
10
+ currency, timing, identifiers, irreversible boundaries, and failure recovery.
11
+ Separate customer intent, provider processing, ledger or balance effects, bank
12
+ or network settlement, and reporting when the product exposes those distinctions.
13
+
14
+ ## Investigate
15
+
16
+ - supported payment or transfer instruments, regions, currencies, and environments;
17
+ - amount representation, rounding, precision, fees, exchange, and balance effects;
18
+ - authorization, capture, cancellation, refund, reversal, dispute, and settlement states;
19
+ - idempotency, duplicate prevention, concurrency, retry, and timeout behavior;
20
+ - synchronous responses versus asynchronous completion and event delivery;
21
+ - webhook signatures, event versions, replay, deduplication, ordering, and recovery;
22
+ - customer, merchant, account, mandate, payout, invoice, and reconciliation identifiers;
23
+ - authentication, permissions, sensitive-data boundaries, logging, and redaction;
24
+ - test data, sandbox differences, operational cutoffs, reports, and exception handling.
25
+
26
+ ## Design coverage
27
+
28
+ Lead with a safe test-environment success path. Explain lifecycle diagrams in
29
+ text and visuals only when every state and transition is evidenced. Put amounts,
30
+ currency, identifiers, idempotency, error handling, and asynchronous completion
31
+ near the first integration—not as late production notes.
32
+
33
+ Show readers how to recognize accepted, pending, completed, failed, canceled,
34
+ refunded, or disputed outcomes supported by the product. Separate customer-facing
35
+ status from settlement or ledger status when they differ. Provide reconciliation
36
+ and exception workflows only where public evidence supports them.
37
+
38
+ ## Navigation overlay
39
+
40
+ Insert supported destinations into Concepts, Integration guides, Reference, and
41
+ Operations:
42
+
43
+ ```text
44
+ Money, currencies, and identifiers
45
+ Payment or transfer lifecycle
46
+ Idempotency and duplicate prevention
47
+ Asynchronous processing and webhooks
48
+ Capture, cancellation, refund, and reversal
49
+ Disputes and exceptions
50
+ Settlement, balances, and reconciliation
51
+ Testing and go-live
52
+ ```
53
+
54
+ Order lifecycle concepts before task guides that depend on state transitions.
55
+
56
+ ## Never assume
57
+
58
+ Do not claim PCI, banking, privacy, sanctions, consumer-protection, tax, or other
59
+ regulatory compliance from source inspection. Do not invent settlement times,
60
+ fund availability, exchange rates, dispute rights, exactly-once processing,
61
+ webhook ordering, loss guarantees, or production parity. Never place real
62
+ financial or personal data in examples or screenshots.
63
+
64
+ ## Senior quality gate
65
+
66
+ An integrator must be able to prevent accidental duplicates using supported
67
+ mechanisms, represent money correctly, track the evidenced lifecycle, verify
68
+ asynchronous notifications, distinguish retryable failure, and reconcile the
69
+ observable outcome without relying on optimistic assumptions.
@@ -0,0 +1,71 @@
1
+ # SaaS application expertise
2
+
3
+ Use for multi-user hosted applications whose reader-visible model includes
4
+ accounts, organizations, workspaces, roles, subscriptions, or browser-based
5
+ workflows.
6
+
7
+ ## Think like a senior SaaS documentation architect
8
+
9
+ Model the experience across three layers: individual identity, shared account or
10
+ workspace, and service-wide behavior. Identify which actor owns each action,
11
+ where settings apply, when changes take effect, and what persists across sessions
12
+ or plan changes. Treat onboarding, daily work, administration, and offboarding as
13
+ different journeys.
14
+
15
+ ## Investigate
16
+
17
+ - signup, invitation, authentication, session, password, and recovery flows;
18
+ - workspace or organization creation, switching, transfer, suspension, deletion;
19
+ - roles, permissions, ownership, approval, and delegation boundaries;
20
+ - the product's primary object lifecycle and collaboration behavior;
21
+ - configuration scope, defaults, inheritance, and propagation;
22
+ - subscription, plan, quota, trial, invoice, or billing behavior when public;
23
+ - import, export, retention, deletion, notification, and audit capabilities;
24
+ - UI labels, empty states, errors, accessibility labels, and responsive behavior;
25
+ - browser, locale, region, or feature-availability commitments supported by evidence.
26
+
27
+ ## Design coverage
28
+
29
+ Separate getting-started content by actor when setup requires both an owner and
30
+ members. Put common daily jobs before rare settings. Give administrators a
31
+ bounded administration area rather than mixing organization-wide changes into
32
+ end-user pages. Connect plan or permission restrictions to the exact task they
33
+ block.
34
+
35
+ For each workflow, state the required role, starting state, scope of effect,
36
+ observable result, and supported reversal. Explain destructive or account-wide
37
+ actions before the reader commits them. Document alternative paths only when
38
+ they are supported and materially useful.
39
+
40
+ ## Navigation overlay
41
+
42
+ Insert supported destinations into the selected type blocks:
43
+
44
+ ```text
45
+ Workspaces or organizations
46
+ Users, groups, roles, and permissions
47
+ Authentication and account recovery
48
+ Shared configuration and integrations
49
+ Plans, usage, and billing
50
+ Audit, export, retention, and deletion
51
+ ```
52
+
53
+ Place daily user tasks in Guides and organization-wide controls in
54
+ Administration. Never merge personal settings with workspace policy merely
55
+ because the UI places them near each other.
56
+
57
+ ## Never assume
58
+
59
+ Do not infer tenant isolation, encryption, backup, regional residency, uptime,
60
+ data retention, auditability, SSO, SCIM, regulatory compliance, accessibility
61
+ conformance, or subscription entitlements from generic SaaS patterns. Verify
62
+ each claim from public interfaces, tests, configuration, policies supplied as
63
+ source, or approved product behavior.
64
+
65
+ ## Senior quality gate
66
+
67
+ A new owner must be able to reach first value; a member must understand their
68
+ available work; and an administrator must be able to predict the scope and
69
+ consequence of supported configuration changes. Terminology for account,
70
+ organization, workspace, project, member, role, and owner must remain exact and
71
+ consistent.
@@ -0,0 +1,65 @@
1
+ # Security and identity expertise
2
+
3
+ Use when identity, authentication, authorization, policy, secrets, audit, or
4
+ security operations are primary reader-visible capabilities.
5
+
6
+ ## Think like a senior security documentation lead
7
+
8
+ Describe trust boundaries and authority precisely. Distinguish identity proof,
9
+ authentication, session establishment, authorization, policy evaluation,
10
+ credential lifecycle, and auditing. State actor, resource, scope, decision, and
11
+ observable result for every sensitive workflow.
12
+
13
+ ## Investigate
14
+
15
+ - identity types, directories, federation, enrollment, verification, and recovery;
16
+ - authentication factors, protocols, sessions, expiry, revocation, and step-up behavior;
17
+ - roles, permissions, scopes, policy evaluation, inheritance, and deny/allow precedence;
18
+ - service accounts, API credentials, keys, certificates, secrets, and rotation;
19
+ - provisioning and deprovisioning, ownership transfer, break-glass paths, and lockout;
20
+ - audit events, timestamps, actors, targets, retention, export, and integrity claims;
21
+ - alerts, detections, incident states, containment, recovery, and evidence collection;
22
+ - public data flows, storage boundaries, logging, redaction, and administrative access;
23
+ - supported security configuration, defaults, limitations, and compatibility.
24
+
25
+ ## Design coverage
26
+
27
+ Put secure setup and least-authority guidance before convenient shortcuts. State
28
+ the role and scope required for every administrative action. Explain default
29
+ behavior, propagation, revocation timing, recovery, and audit evidence where
30
+ supported. Separate end-user access recovery from administrator incident actions.
31
+
32
+ Use fictional identities and redacted tokens. Never include executable examples
33
+ that weaken verification, bypass authorization, disable protection without
34
+ context, or expose credentials. Explain risk before consequential configuration.
35
+
36
+ ## Navigation overlay
37
+
38
+ Insert supported destinations by the identity and authority lifecycle:
39
+
40
+ ```text
41
+ Identities and directories
42
+ Authentication and recovery
43
+ Sessions and factors
44
+ Roles, permissions, and policy
45
+ Service accounts and credentials
46
+ Provisioning and deprovisioning
47
+ Audit events and reporting
48
+ Alerts, incidents, and recovery
49
+ ```
50
+
51
+ Place secure setup, authority boundaries, and lockout recovery before convenient
52
+ administrative shortcuts.
53
+
54
+ ## Never assume
55
+
56
+ Do not claim zero trust, least privilege, encryption properties, tamper-proof
57
+ auditing, protocol conformance, certification, compliance, breach prevention,
58
+ revocation latency, or secure defaults without authoritative evidence. Do not
59
+ publish internal detection logic or sensitive architecture without a reader need.
60
+
61
+ ## Senior quality gate
62
+
63
+ A reader must understand who can perform each sensitive action, what authority
64
+ is granted, where credentials live, how access is revoked and verified, what is
65
+ audited, and how to recover from supported lockout or compromise scenarios.
@@ -0,0 +1,105 @@
1
+ # Doxloop editorial standard
2
+
3
+ Apply this house standard unless the persisted documentation brief names a
4
+ project-specific alternative.
5
+
6
+ ## Resolve conflicting guidance
7
+
8
+ Use this precedence:
9
+
10
+ 1. confirmed project terminology, audience, and house style;
11
+ 2. verified product behavior and public interface names;
12
+ 3. this Doxloop editorial standard;
13
+ 4. the configured external style guide;
14
+ 5. general language conventions.
15
+
16
+ Use Diátaxis to distinguish tutorials, how-to guides, reference, and
17
+ explanation. Use the Google developer documentation style guide as the default
18
+ external editorial reference and Microsoft technical-writing guidance as a
19
+ supplement. Treat these as guidance, not proof of formal conformance. Do not
20
+ copy external standards or style guides into the documentation.
21
+
22
+ For a formal information-development program, map the workflow and quality
23
+ evidence to a licensed copy of ISO/IEC/IEEE 26514:2022. Do not claim ISO
24
+ conformance from this house standard or an agent review alone.
25
+
26
+ ## Write in a professional voice
27
+
28
+ - Address the reader as **you** when giving instructions.
29
+ - Prefer active voice, concrete verbs, and present tense.
30
+ - Be direct, respectful, calm, and technically precise.
31
+ - Use everyday language when it remains accurate. Define necessary specialist
32
+ terms on first use for readers who may not know them.
33
+ - Avoid hype, jokes that may not translate, idioms, blame, and false certainty.
34
+ - Use contractions only when they fit the confirmed voice.
35
+ - Do not use *simple*, *easy*, *obvious*, or *just* to dismiss reader effort.
36
+
37
+ ## Make content scannable
38
+
39
+ - Use sentence case for titles and headings.
40
+ - Put the reader outcome or most important condition first.
41
+ - Keep paragraphs focused on one idea.
42
+ - Use a list only for genuinely parallel items.
43
+ - Use numbered steps only for sequences.
44
+ - Introduce tables only when readers need to compare several exact values.
45
+ - Use descriptive link text that makes sense out of context. Never use
46
+ *click here*, *here*, or *read more* as the complete link text.
47
+ - Keep notes close to the text they qualify. Reserve warnings and dangers for
48
+ material risk rather than general emphasis.
49
+
50
+ ## Keep titles and headings concise
51
+
52
+ - Write task-page titles with a direct imperative verb. Prefer *Keep
53
+ documentation updated* over *Keeping documentation updated*.
54
+ - Aim for 3–7 words and no more than 50 characters in a page title.
55
+ - Aim for 2–5 words and no more than 32 characters in a navigation label.
56
+ - Aim for 2–7 words and no more than 45 characters in a section heading that
57
+ appears in the page table of contents.
58
+ - Shorten a navigation label when needed, but preserve the meaning of the page
59
+ title. Do not repeat the navigation group name in each child label.
60
+ - Move qualifications and explanatory detail into the page description or
61
+ opening paragraph.
62
+ - For CLI and API reference sections, use only the command, operation, or
63
+ resource name as the heading. Put arguments, options, methods, and paths
64
+ immediately below the heading.
65
+ - Treat the length limits as warning thresholds, not hard errors. Keep an exact
66
+ product or interface name when shortening it would make the documentation
67
+ inaccurate.
68
+
69
+ ## Write usable procedures
70
+
71
+ - State the goal and prerequisites before the first step.
72
+ - Begin each step with the reader action.
73
+ - Put one primary action in each step.
74
+ - Place conditions before the action when they change what the reader must do.
75
+ - Keep explanatory asides outside the step sequence when possible.
76
+ - Show the observable result after a meaningful action or at the end.
77
+ - Provide recovery guidance only when supported by product evidence.
78
+ - End with the next useful action, not a generic conclusion.
79
+
80
+ ## Keep terminology stable
81
+
82
+ - Use the exact names visible in the product UI, CLI, API, and configuration.
83
+ - Apply the terminology map in `.doxloop/project.json`.
84
+ - Use one preferred term for one concept; do not vary wording for style.
85
+ - Expand unfamiliar abbreviations on first use unless the audience brief says
86
+ they are assumed knowledge.
87
+ - Preserve capitalization used by public product interfaces.
88
+ - Format commands, files, keys, parameters, values, and code identifiers as
89
+ code where the selected generator supports it.
90
+
91
+ ## Support global readers
92
+
93
+ - Use complete, conventional sentence structures.
94
+ - Keep the subject and verb close together.
95
+ - Avoid ambiguous pronouns and long chains of clauses.
96
+ - Include articles such as *a*, *an*, and *the* when required.
97
+ - Use locale-appropriate spelling, dates, numbers, and punctuation from the
98
+ persisted brief.
99
+ - Do not encode meaning in wordplay or culturally specific references.
100
+
101
+ ## Exclude editorial noise
102
+
103
+ Do not include generic introductions, repeated product claims, invented
104
+ benefits, internal implementation trivia, unsupported superlatives, redundant
105
+ summaries, or prose that exists only to make a page longer.
@@ -0,0 +1,71 @@
1
+ # Evidence and example standard
2
+
3
+ Use this standard whenever documentation states product behavior or contains a
4
+ command, request, configuration, or code sample.
5
+
6
+ ## Track claim status
7
+
8
+ Classify material while researching:
9
+
10
+ - **Verified by execution**: a safe local command or example completed and its
11
+ observable result matched the documentation.
12
+ - **Verified by source**: a public interface, schema, test, or fixture directly
13
+ supports the claim.
14
+ - **Inferred**: several sources support the conclusion, but no public contract
15
+ states it directly.
16
+ - **Unverified**: the available evidence cannot establish the behavior.
17
+
18
+ Publish verified claims. Include an inference only when it is necessary, label
19
+ the uncertainty, and avoid promising unsupported behavior. Do not publish an
20
+ unverified claim as fact.
21
+
22
+ Keep a working evidence map from each planned page or public capability to the
23
+ configured source file, schema, test, fixture, or safe execution that supports
24
+ it. Use configured source names and relative paths in working notes. Never copy
25
+ local absolute paths into reader-facing documentation or deployment content.
26
+
27
+ ## Build trustworthy examples
28
+
29
+ For every example:
30
+
31
+ 1. Define what the reader will accomplish.
32
+ 2. State required versions, permissions, setup, files, and environment.
33
+ 3. Use the smallest realistic input that demonstrates the supported behavior.
34
+ 4. Use exact public names, flags, keys, types, and values.
35
+ 5. Use visibly fake credentials and reserved example domains where needed.
36
+ 6. Show the command, request, configuration, or code in a copyable form.
37
+ 7. Show the expected output or explain the observable success condition.
38
+ 8. Include cleanup when the example creates billable, persistent, or sensitive
39
+ resources.
40
+ 9. Verify the example safely by execution when possible; otherwise verify every
41
+ material detail against public source and tests.
42
+
43
+ Keep example output short and stable. Replace volatile IDs, timestamps, and
44
+ paths with clearly marked placeholders without changing their required shape.
45
+ Never place a placeholder where a literal value is required without explaining
46
+ how the reader obtains it.
47
+
48
+ ## Protect readers and source
49
+
50
+ - Never use or reveal real credentials, tokens, personal data, internal hosts,
51
+ private identifiers, or unpublished endpoints.
52
+ - Do not run destructive, billable, privileged, or remote actions solely to
53
+ verify documentation without explicit user approval.
54
+ - Explain security consequences before a risky action.
55
+ - Prefer least-privilege permissions in examples.
56
+ - Do not recommend disabling security controls as a generic fix.
57
+ - Do not copy implementation details into reference material when the public
58
+ contract provides the correct reader-facing description.
59
+
60
+ ## Cover specialized public interfaces
61
+
62
+ For CLI reference, verify commands, arguments, flags, defaults, environment
63
+ behavior, output, exit behavior, and failure cases.
64
+
65
+ For API reference, prefer the project's declared OpenAPI or equivalent schema.
66
+ Cover authentication, methods and paths, parameters, request and response
67
+ shapes, status or error behavior, limits, and one verified example. Follow the
68
+ version of the interface description present in the configured source.
69
+
70
+ For configuration reference, verify keys, types, defaults, allowed values,
71
+ precedence, restart or reload behavior, security implications, and examples.
@@ -0,0 +1,152 @@
1
+ # Professional navigation architecture
2
+
3
+ Use this reference when creating a site, adding a reader journey, restructuring
4
+ documentation, or reviewing information architecture. Define a semantic
5
+ navigation plan first; then use the selected generator skill to implement it in
6
+ native configuration.
7
+
8
+ ## Compose navigation
9
+
10
+ Build navigation in this order:
11
+
12
+ 1. start with the common site frame;
13
+ 2. add the blocks from each selected documentation-type playbook;
14
+ 3. apply the primary and adjacent domain overlays;
15
+ 4. use audience flavor to change emphasis, ordering, terminology, and depth;
16
+ 5. remove unsupported, empty, duplicate, or out-of-scope destinations;
17
+ 6. translate the semantic plan into the generator's top navigation, sidebar,
18
+ menu, toctree, page map, or manifest.
19
+
20
+ Templates propose reader destinations; configured product evidence determines
21
+ whether the destination exists and what it says.
22
+
23
+ ## Common top navigation
24
+
25
+ Use top navigation for major documentation surfaces, not for every content
26
+ group. Keep approximately five primary items and preserve project conventions.
27
+
28
+ | Slot | Default label | Include when |
29
+ | --- | --- | --- |
30
+ | Primary | Documentation | always for a documentation site |
31
+ | Reference surface | API, SDKs, CLI, or Reference | a substantial maintained lookup surface exists |
32
+ | Integration surface | Integrations | integrations are a primary product destination |
33
+ | Lifecycle | Release notes | release-visible change is maintained |
34
+ | Help | Support | a verified support destination exists |
35
+
36
+ Search, version, locale, theme, repository, status, and product-dashboard links
37
+ are utilities. Place them in generator-native utility controls or secondary
38
+ links instead of displacing the primary reader journey. Never invent a support,
39
+ status, repository, changelog, or product URL.
40
+
41
+ Promote at most two product surfaces such as API, SDKs, CLI, Integrations, or
42
+ Administration. Keep the rest inside Documentation. Use one stable label for a
43
+ destination across desktop, mobile, breadcrumbs, and side navigation.
44
+
45
+ ## Common left-navigation grammar
46
+
47
+ Order groups by the reader's progression:
48
+
49
+ ```text
50
+ Overview
51
+
52
+ Getting started
53
+ Prerequisites
54
+ Installation or access
55
+ Quickstart
56
+ Next steps
57
+
58
+ Guides
59
+ Common workflows
60
+ Advanced workflows
61
+ Integrations
62
+
63
+ Concepts
64
+ Core concepts
65
+ Resource or object lifecycle
66
+ Security or trust model
67
+
68
+ Reference
69
+ Public interface reference
70
+ Configuration
71
+ Errors and limits
72
+
73
+ Operations
74
+ Deployment or administration
75
+ Observability
76
+ Backup and recovery
77
+
78
+ Troubleshooting
79
+ Diagnose problems
80
+ Error reference
81
+ Get support
82
+
83
+ Releases
84
+ Migration guides
85
+ Deprecations
86
+ Release notes
87
+ ```
88
+
89
+ This is a grammar, not a mandatory page tree. Omit a group when no selected
90
+ type/domain module contributes a supported reader destination.
91
+
92
+ ## Size the structure
93
+
94
+ ### Compact
95
+
96
+ Use for one primary workflow and a small public surface. Keep Overview, Getting
97
+ started, Guides, Reference, and Troubleshooting as needed. Prefer pages over
98
+ single-item groups.
99
+
100
+ ### Standard
101
+
102
+ Use by default for a product with several workflows. Include distinct Getting
103
+ started, Guides, Concepts, Reference, and Troubleshooting groups; add Operations
104
+ or Releases when supported.
105
+
106
+ ### Comprehensive
107
+
108
+ Use when several reader journeys or public surfaces need independent depth.
109
+ Create top-level surfaces or spaces only when they have their own overview,
110
+ onboarding path, tasks, concepts, reference, and maintenance needs. Avoid one
111
+ sidebar that mixes unrelated audiences and becomes difficult to scan.
112
+
113
+ ## Merge type blocks
114
+
115
+ - Keep one Overview destination for the site or major surface.
116
+ - Merge duplicate Getting started groups and order their pages by dependency.
117
+ - Put outcome-focused pages under Guides; do not group by source directory.
118
+ - Share a concept page only when its mental model is identical for all readers.
119
+ - Keep API, SDK, and CLI reference boundaries distinct even if top navigation
120
+ exposes only one `Reference` destination.
121
+ - Merge troubleshooting articles by symptom, not by the page that links to them.
122
+ - Put migration guides before chronological release notes when readers must act.
123
+ - Do not place the same page in primary navigation more than once; cross-link it.
124
+
125
+ ## Apply audience flavor
126
+
127
+ - Developers see first success, guides, examples, and reference early.
128
+ - Administrators see setup, identities, policy, configuration effect, and audit
129
+ before ordinary end-user workflows.
130
+ - End users see goal-oriented tasks and personal settings before concepts.
131
+ - Platform engineers and operators see architecture, deployment, health,
132
+ observability, change, and recovery early.
133
+ - Support readers see symptom-led diagnostics and escalation evidence early.
134
+
135
+ When audiences have different permissions, tools, risks, or success criteria,
136
+ use separate navigation journeys or spaces. Do not create top-level audience
137
+ labels merely because several audiences exist.
138
+
139
+ ## Navigation quality gate
140
+
141
+ - Every reader-facing page is reachable exactly once through primary navigation.
142
+ - The primary reader can identify the first step and common jobs without search.
143
+ - Labels are 2–5 words where possible, use reader vocabulary, and remain distinct.
144
+ - Group order follows task dependency and frequency, not alphabetic filenames.
145
+ - Navigation normally stays within three visible levels.
146
+ - Empty, speculative, single-item, and duplicate groups are removed.
147
+ - Top navigation contains only verified destinations and remains usable at
148
+ narrow widths and keyboard zoom.
149
+ - Routes and labels remain stable during updates unless the user requested an
150
+ information-architecture change or the old structure blocks reader success.
151
+ - Breadcrumbs, previous/next links, landing-page cards, and side navigation use
152
+ the same hierarchy and terminology where the generator supports them.