Skip to content

docs(root): clarify repository architecture - #1891

Open
sylvesterkaczmarek wants to merge 1 commit into
mi6:developfrom
sylvesterkaczmarek:docs/1852-repo-architecture-diagram
Open

sylvesterkaczmarek wants to merge 1 commit into
mi6:developfrom
sylvesterkaczmarek:docs/1852-repo-architecture-diagram

Conversation

@sylvesterkaczmarek

Copy link
Copy Markdown

Summary

Add a small Mermaid architecture diagram near the top of the README to show how ic-design-system and ic-ui-kit relate to their published outputs.

Change

  • show ic-design-system publishing the guidance site;
  • show ic-ui-kit publishing the @ukic/* component packages;
  • show that the guidance documents use of the component packages;
  • clarify which repository contributors should use for documentation versus component changes.

The diagram uses GitHub-native Mermaid and requires no additional build or hosted asset.

Closes #1852

@GCHQ-Developer-530

Copy link
Copy Markdown
Contributor

Please can you rebase this pull request?

@sylvesterkaczmarek
sylvesterkaczmarek force-pushed the docs/1852-repo-architecture-diagram branch from b28611f to 92db899 Compare August 21, 2026 20:19
@sylvesterkaczmarek

Copy link
Copy Markdown
Author

Rebased onto the latest develop. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants