3 Commits

Author SHA1 Message Date
Michael Snowden
676657cbf4 Reorganize docs (#5535)
## 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) -->
2024-03-18 23:13:02 -07:00
Carly de Frondeville
3532e3551b docs: add PR template reminder, Makefile, and assets folder (#5423)
## What changed?
- Add PR template reminder to update docs
- Add first d2 diagram to Matching README (more to follow)
- Refactor `docs` folder to contain an `assets` folder where we store
images for all the READMEs in the project, instead of using github
assets

## Why?
To improve how we interact with and update docs

## How did you test it?
n/a

## Potential risks
n/a

## Is hotfix candidate?
no

---------

Co-authored-by: Stephan Behnke <stephan.behnke@temporal.io>
Co-authored-by: Dan Davison <dan.davison@temporal.io>
2024-02-21 11:28:10 -08:00
Dan Davison
60a5c66e5b Initial docs draft: Overview, History Service, Workflow Lifecycle (#4950)
System architecture / internal implementation docs

- Temporal overview
- History Service
- Workflow lifecycle
2023-11-16 17:42:37 -05:00