mirror of
https://github.com/temporalio/temporal.git
synced 2026-08-31 02:51:51 -07:00
676657cbf4
## What changed?
<!-- Describe what has changed in this PR -->
I reorganized our docs into `docs/{admin,architecture,development}`.
## Why?
<!-- Tell your future self why have you made these changes -->
We discussed this internally, but I believe this is a better
segmentation for the different audiences looking at our docs. I plan on
adding more stuff to docs/admin like metrics and dynamic config docs.
## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
I'm mainly looking for broken links.
- I went through each markdown file in docs manually.
- I looked through all inspection errors in the IDE.
- I looked at all references to "docs/" or "develop/" in our code.
## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->
## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
20 lines
1.4 KiB
Markdown
20 lines
1.4 KiB
Markdown
# Temporal Server Documentation
|
|
|
|
This folder contains docs for those working closely with the Temporal server.
|
|
If you are more interested in just authoring workflows, see our [Getting Started Guide](../README.md#getting-started).
|
|
|
|
## Core Documentation Sections
|
|
|
|
### Architectural Diagrams (`/architecture`)
|
|
This section contains high-level explanations of Temporal's architecture and core concepts.
|
|
It is designed to be useful for both server developers and those interested in understanding the technological underpinnings of Temporal.
|
|
Detailed diagrams and descriptions can be found there.
|
|
|
|
### Development Instructions (`/development`)
|
|
Here, you'll find guides to setting up a local development environment, along with potentially more advanced topics such as adding migrations or new Remote Procedure Calls (RPCs).
|
|
This section is essential for developers looking to contribute to the Temporal codebase or understand its inner workings.
|
|
|
|
### Operational Guides (`/admin`)
|
|
This section provides reference materials for administrators responsible for deploying Temporal in a production environment.
|
|
It is pretty bare for now, but it is intended to covers topics like spinning up a production environment, configuring it, and monitoring it with metrics and dynamic configurations.
|
|
For now, you can find this info on the Temporal docs website at https://docs.temporal.io/self-hosted-guide. |