Skip to content

docs: add task-oriented architecture guide#178

Merged
mattsse merged 1 commit into
mainfrom
mattsse/docs-information-architecture
Jul 16, 2026
Merged

docs: add task-oriented architecture guide#178
mattsse merged 1 commit into
mainfrom
mattsse/docs-information-architecture

Conversation

@mattsse

@mattsse mattsse commented Jul 16, 2026

Copy link
Copy Markdown
Member

Summary

  • add a task-to-documentation map that routes common Alloy jobs to concepts and runnable examples
  • explain the crate and runtime layers from core types through transports, providers, wallets, and contracts
  • add a feature flag reference with starting profiles, capability mappings, TLS choices, and troubleshooting
  • simplify installation into an entry point and collapse the large examples navigation group

Why

The site currently starts with installation and API-specific guides but does not explain how the crates compose or how to choose features. Users and coding agents have to infer the correct path from a long flat navigation tree, while the installation page mixes onboarding with an incomplete crate inventory.

Impact

Newcomers can choose a workflow before learning the whole stack, library authors can identify the correct dependency boundary, and agents get explicit task and feature vocabulary for retrieval. Versioned Cargo snippets remain generated from the single documentation version source.

@mattsse
mattsse requested a review from grandizzy July 16, 2026 11:02
@mattsse
mattsse changed the base branch from mattsse/docs-correctness to main July 16, 2026 14:44
@mattsse
mattsse force-pushed the mattsse/docs-information-architecture branch from 43e212c to b091bb9 Compare July 16, 2026 14:44
@mattsse
mattsse merged commit 038cb4c into main Jul 16, 2026
2 checks passed
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.

1 participant