Docs split Phase 1: docs.roboco.tech becomes canonical — redirect stubs, user tree removed, MkDocs retired (#299)

* docs: replace MkDocs deploy with static redirect stubs

docs.roboco.tech (roboco-website) is now the canonical user-facing docs
site (spec: docs/internal/specs/2026-07-03-docs-site-split.md). Every URL
this repo's Pages site published needs to keep resolving, so
scripts/gen_docs_redirects.py generates one meta-refresh + rel=canonical
stub per page — derived from mkdocs.yml's nav while it still lists every
page — into the committed docs-redirects/ directory. All 58 stub targets
verify against the website repo's nav.ts (0 unmapped); the only rename is
how-to/* -> tour/* per the spec's slug map.

Rewrite .github/workflows/docs.yml to deploy docs-redirects/ directly
instead of running `mkdocs build`. The user-facing docs/ tree and
mkdocs.yml itself are untouched here — deleting them is the next step,
gated on these stubs resolving correctly.

* docs: delete the MkDocs user-facing tree, docs.roboco.tech is canonical

Per docs/internal/specs/2026-07-03-docs-site-split.md decision (1):
Material->MDX is not verbatim-portable, so repo A's user-facing docs are
deleted rather than kept as a permanently-drifting mirror. Deletes
index/get-started/company/how-to/panel/models/operations/optional/deploy/
api/troubleshooting plus images/videos/assets. KEEPS docs/rag/ (indexed
agent corpus), docs/map/, docs/internal/, and the team buckets
(backend/frontend/ux_ui) — none of these were ever in mkdocs.yml's nav.

mkdocs.yml's entire nav mapped 1:1 onto the deleted tree, so pruning it
"accordingly" leaves nothing — remove it outright, along with the now-dead
`docs` optional-dependency group (mkdocs/mkdocs-material/mkdocstrings/
pymarkdownlnt — mkdocstrings was already unused, not wired into any mkdocs
plugin), the matching deptry DEP002 ignore entries, .pymarkdown.json, and
the serve-docs/build-docs/lint-docs/fix-docs Makefile targets (all scoped
only to the deleted paths). Add regen-docs-redirects as the one remaining
docs Makefile target.

Repointed everything that linked into the deleted tree or the old Pages
URL: README's hero video/gif and walkthrough links now hit the docs.roboco.tech-hosted
copies (already duplicated there per the spec's ground truth), usage.md /
deployment.md's jump-links, pyproject's Documentation URL, and CLAUDE.md's
Blueprint Reference paragraph.

* chore: sync uv.lock after removing the docs optional-dependency group

Follow-up to the mkdocs.yml / docs extra removal — mkdocs, mkdocs-material,
mkdocstrings, pymarkdownlnt, and their transitive-only dependencies drop
out of the lockfile now that nothing in pyproject.toml declares them.

---------

Co-authored-by: Renn F <rennf93@users.noreply.github.com>
This commit is contained in:
Renzo F
2026-07-03 02:04:59 +02:00
committed by GitHub
co-authored by Renn F
parent 876e19b389
commit 5936c2bdea
158 changed files with 917 additions and 4473 deletions
+8 -28
View File
@@ -428,29 +428,13 @@ high-load-stress-test:
@docker compose down --rmi all --remove-orphans -v
@docker system prune -f
# Serve docs
.PHONY: serve-docs
serve-docs:
@uv run --extra docs mkdocs serve
@find . | grep -E "(__pycache__|\.pyc|\.pyo|\.pytest_cache|\.ruff_cache|\.mypy_cache)" | xargs rm -rf
# Build the documentation site (strict — fails on broken links / nav)
.PHONY: build-docs
build-docs:
@uv run --extra docs mkdocs build --strict
@find . | grep -E "(__pycache__|\.pyc|\.pyo|\.pytest_cache|\.ruff_cache|\.mypy_cache)" | xargs rm -rf
# Lint documentation
.PHONY: lint-docs
lint-docs:
@uv run --extra docs pymarkdownlnt --config .pymarkdown.json scan -r docs/index.md docs/get-started docs/company docs/how-to docs/panel docs/models docs/operations docs/optional docs/deploy docs/api docs/troubleshooting
@find . | grep -E "(__pycache__|\.pyc|\.pyo|\.pytest_cache|\.ruff_cache|\.mypy_cache)" | xargs rm -rf
# Fix documentation
.PHONY: fix-docs
fix-docs:
@uv run --extra docs pymarkdownlnt --config .pymarkdown.json fix -r docs/index.md docs/get-started docs/company docs/how-to docs/panel docs/models docs/operations docs/optional docs/deploy docs/api docs/troubleshooting
@find . | grep -E "(__pycache__|\.pyc|\.pyo|\.pytest_cache|\.ruff_cache|\.mypy_cache)" | xargs rm -rf
# Regenerate the GitHub Pages redirect stubs (docs-redirects/) that replaced
# the old MkDocs-built site — docs.roboco.tech is canonical now. Only needed
# if a legacy URL is missing a stub; requires a restored copy of the old
# nav-bearing mkdocs.yml (see git history) since the live one is gone.
.PHONY: regen-docs-redirects
regen-docs-redirects:
@uv run python scripts/gen_docs_redirects.py
# Prune
.PHONY: prune
@@ -514,16 +498,12 @@ help:
@echo " make test-all - Run tests (all Python versions)"
@echo " make stress-test - Run stress test"
@echo ""
@echo "Documentation:"
@echo " make serve-docs - Serve documentation"
@echo " make lint-docs - Lint markdown files"
@echo ""
@echo "Cleanup:"
@echo " make stop - Stop all containers"
@echo " make clean - Clean cache files"
@echo " make prune - Prune docker resources"
@echo ""
@echo "Full docs: https://rennf93.github.io/roboco/ (preview locally: make serve-docs)"
@echo "Full docs: https://docs.roboco.tech"
# Python versions list
.PHONY: show-python-versions