mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Michael SnowdenandGitHub
c504991e6d
## 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) -->
12 lines
360 B
Makefile
12 lines
360 B
Makefile
.DEFAULT_GOAL := update-diagrams
|
|
COLOR := "\e[1;36m%s\e[0m\n"
|
|
DIAGRAMS := $(wildcard ./docs/_assets/*.d2)
|
|
|
|
install-d2:
|
|
@printf $(COLOR) "Install d2..."
|
|
@go install oss.terrastruct.com/[email protected]
|
|
|
|
update-diagrams: install-d2
|
|
@printf $(COLOR) "Update diagrams"
|
|
$(foreach DIAGRAM, $(DIAGRAMS), d2 --layout elk --theme 7 --dark-theme 200 $(DIAGRAM) $(NEWLINE))
|