From ff8079feef60d6729a8b7afc9f20df841165f81d Mon Sep 17 00:00:00 2001 From: Reece Williams Date: Thu, 14 Nov 2024 15:28:35 -0600 Subject: [PATCH] chore(docs): add context --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bcd285b60..9c8c71e6d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Built with [Docusaurus 2](https://docusaurus.io/). -An aggregation of Interchain stack components documentation in 1 place. +An aggregation of Interchain stack components documentation in 1 place. ## Installation @@ -45,6 +45,8 @@ $ npm run build ## Context +Every external documentation repo is not saved here for efficiency. Teams modify their upstream docs where they feel comfortable. This pipeline downloads, modifies, and builds the external docs to fit the aggregated use-case in a developer experience friendly way. Git commits are used for deterministic syncing even if an auto generated merge takes a period of time. This keep PRs small and clean while allowing for faster git clones as this repo expands. This commit based approach has checks with CI/CD to ensure the latest changes are still valid and no broken links are found. if they are, a reviewer can test it on their machine locally to verify what scripts need to be modified. Once approved and merged the CI/CD will deploy the changes to the live site. + ### dsource- `dsource-` directories are "documentation sources". This is the upstream source of truth. They are shallow cloned so only the commits required are saved, keeping instances lightweight for local and CI development.