Documentation map
Bundle OKF 0.2 · 15 conceitos · LogHosp/guide
Open source Repository Open in the app JSON
About
# Documentation map
Documentation for `guide`, an MIT-licensed monorepo publishing two React packages: `@guide/core`,
a headless product-tour engine, and `@guide/mui`, its MUI rendering layer.
Read this file first, then the playbook relevant to your task. Contribution triggers are in
[AGENTS.md](../AGENTS.md).
## Root guides
| Document | What it covers |
| --- | --- |
| [README.md](../README.md) | The public API reference — every prop, event and option a consumer uses. Copied verbatim into each package and published to npm; the two copies carry no frontmatter, per [ADR 0010](adr/0010-shipped-package-readmes-exempt-from-frontmatter.md). |
| [ARCHITECTURE.md](../ARCHITECTURE.md) | Package layering, target resolution, cross-page navigation, spotlight geometry, accessibility, known seams. |
| [CONTRIBUTING.md](../CONTRIBUTING.md) | Prerequisites, commands, branch and commit conventions, language policy, licence discipline. |
| [INFRA.md](../INFRA.md) | Build, continuous integration and
Details
- Kind
- OKF bundles
- Topic
- Maps, weather & travel
- Publisher
- loghosp
- Origin
- okf_github
- Category
- dados
- Version
- 0.2
- Added
- 2026-09-09 12:02:17
- Updated
- 2026-09-09 12:02:17
- Origin id
LogHosp/guide:docs/index.md