Skip to content

Docs vs Design Relationship

This page defines the content ownership boundary and collaboration flow between:

  • docs.trystpilot.xyz (source: docs/)
  • design.trystpilot.xyz (source: design/)
Content TypeCanonical LocationWhy
Runbooks, setup, CI/CD ops, incident responsedocs/Operational reliability and execution guidance
Changelog, release/version reconciliationdocs/Product and deployment source-of-truth for releases
Architecture diagrams and visual mapsdesign/Diagram-first, design-native artifacts
UI/UX flows and wireframe narrativesdesign/Design intent and interaction documentation
Governance visual modelsdesign/Access and moderation flows are maintained as diagrams
  1. Docs pages should link to design pages when visuals are needed.
  2. Design pages should link to docs pages for implementation and operational constraints.
  3. Duplicate long-form copies of the same content across both sites should be avoided.
  4. If overlap is required, designate one canonical page and mark the other as a short pointer.
  1. Author/update content in the canonical directory (docs/ or design/).
  2. Add cross-links in the counterpart site only as pointers.
  3. Keep roadmap/versioning/date-sensitive operational truth in docs site artifacts.
  4. Validate navigation consistency during PR review.