Skip to main content

ChainAlign Documentation Guide

This guide provides a brief overview of the directory structure and where to place new documents.

Directory Structure​

  • architecture: Contains all documents related to the technical architecture of the ChainAlign platform. This includes high-level overviews, deep dives into specific components, and integration specifications.
  • go-to-market: Contains all documents related to the go-to-market strategy, including marketing materials, sales collateral, and competitive analysis.
  • kb-curation: Contains documents related to the curation of the knowledge base, including curated articles and the curation pipeline manager.
  • product-vision: Contains all documents related to the product vision, including the product requirements document (PRD), user flows, and feature specifications.
  • project-management: Contains all documents related to project management, including task lists, status reports, and meeting notes.
  • strategy-and-research: Contains all documents related to strategy and research, including market research, competitive analysis, and strategic notes.
  • ux-design: Contains all documents related to user experience and design, including brand guidelines, mockups, and component libraries.
  • uncategorized: Contains all documents that do not fit into any of the other categories.

Adding New Documents​

When adding a new document, please place it in the most relevant category. If you are unsure where to place a document, please consult with the project lead.