External/roboco
1
0
Fork 0
mirror of https://github.com/rennf93/roboco.git synced 2026-08-03 07:23:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files
docs-redirects/operations/cost-and-usage/index.html
+12
View File
@@ -0,0 +1,12 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Cost & usage</title>
<meta http-equiv="refresh" content="0; url=https://docs.roboco.tech/docs/operations/cost-and-usage">
<link rel="canonical" href="https://docs.roboco.tech/docs/operations/cost-and-usage">
</head>
<body>
<p>This page has moved to <a href="https://docs.roboco.tech/docs/operations/cost-and-usage">https://docs.roboco.tech/docs/operations/cost-and-usage</a>.</p>
</body>
</html>
docs-redirects/operations/health-and-metrics/index.html
+12
View File
@@ -0,0 +1,12 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Health & metrics</title>
<meta http-equiv="refresh" content="0; url=https://docs.roboco.tech/docs/operations/health-and-metrics">
<link rel="canonical" href="https://docs.roboco.tech/docs/operations/health-and-metrics">
</head>
<body>
<p>This page has moved to <a href="https://docs.roboco.tech/docs/operations/health-and-metrics">https://docs.roboco.tech/docs/operations/health-and-metrics</a>.</p>
</body>
</html>
docs-redirects/operations/index.html
+12
View File
@@ -0,0 +1,12 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Cost & Observability</title>
<meta http-equiv="refresh" content="0; url=https://docs.roboco.tech/docs/operations">
<link rel="canonical" href="https://docs.roboco.tech/docs/operations">
</head>
<body>
<p>This page has moved to <a href="https://docs.roboco.tech/docs/operations">https://docs.roboco.tech/docs/operations</a>.</p>
</body>
</html>