Getting Started¶
This site documents the Musingly platform — its architecture, services, shared libraries, and product features.
Who This Is For¶
- Engineers building or maintaining Musingly services
- Architects making cross-service design decisions
- Product contributors reviewing feature specifications
How to Navigate¶
The left sidebar organizes content into sections. Use the search bar (shortcut: /) to find anything across the full site. The table of contents on the right tracks your position within long pages.
Sections are independent — you do not need to read them in order.
Documentation Types¶
Each page is labeled with one of these content types:
| Type | Purpose | Examples |
|---|---|---|
| Reference | Look up a fact | API endpoints, configuration keys, component props |
| Guide | Complete a task | Deploy a service, configure authentication, run tests |
| Explanation | Understand a decision | Architecture decisions, design tradeoffs |
| Research | Explore an idea | Proposals, concepts, working notes |
Research pages are exploratory and not authoritative. They are clearly marked with a warning banner.
Updating This Site¶
See the contributing guide to add or update documentation.