chore: remove old Hugo docs generation#856
Conversation
These workflows pushed the docs.kosli.com/ directory to docs-main and staging-docs branches for Netlify Hugo builds. No longer needed now that docs are generated via Mintlify in kosli-dev/docs. Part of kosli-dev/docs#42
… output - Remove the docs-gen job that generated CLI reference markdown and pushed docs.kosli.com/ to the docs-main branch on every release - Remove the docs-gen dependency from the failure-notification job - Remove the helm-docs line that wrote to docs.kosli.com/content/helm/ The docs-repo-dispatch job is kept — it notifies kosli-dev/docs of new CLI releases so Mintlify can regenerate. Part of kosli-dev/docs#42
Remove targets: cli-docs, legacy-ref-docs, generate-json-metadata, hugo, hugo-local, test_docs, check-links, and the second helm-docs output line that wrote to docs.kosli.com/. Delete scripts: - bin/test_docs_cmds.sh (tested commands embedded in Hugo markdown) - hack/generate-old-versions-docs.sh (generated legacy version docs) Part of kosli-dev/docs#42
Remove the entire Hugo documentation site (239 tracked files): config, layouts, content, assets, static files, and Netlify config. Documentation is now maintained in the kosli-dev/docs Mintlify repo. Part of kosli-dev/docs#42
- Delete internal/docgen/hugo.go and hugo_test.go - Remove --mintlify flag from `kosli docs` (Mintlify is now the only format) - Update generate_test.go and formatter_test.go to use MintlifyFormatter - Update docs_test.go to compare against Mintlify golden files - Delete Hugo golden test fixtures (testdata/output/docs/hugo/) Part of kosli-dev/docs#42
- Remove docs.kosli.com/ patterns from .gitignore - Delete .clear-files (preserved Hugo-generated content during deploys) - Delete .htmltest.yml (pointed at Hugo build output) - Update README.md and dev-guide.md docs links - Update release-guide.md: remove old docs generation/hosting sections, document Mintlify dispatch workflow Closes kosli-dev/docs#42
1b58e47 to
e44fa90
Compare
|
Claude finished @dangrondahl's task in 2m 22s —— View job PR Review: Remove old Hugo docs generation
Static AnalysisAll three checks pass cleanly:
ReviewThis is a clean, well-structured removal. The PR systematically eliminates the Hugo docs pipeline across all layers — workflows, Makefile, Go code, test data, and documentation — without leaving dangling references. A few observations: Things done well
Minor observations (non-blocking)The SummaryClean PR — no issues found. The Hugo docs infrastructure is fully removed, the Mintlify path is the sole remaining doc format, and the release pipeline dependencies are consistent. LGTM. |
## Summary - Removes the `--mintlify` flag from `kosli docs` in the reference docs workflow, since Mintlify becomes the default (and only) format after kosli-dev/cli#856. Closes #203 ## Blocked on - kosli-dev/cli#856 ## Test plan - [ ] Merge kosli-dev/cli#856 - [ ] Trigger the `Update Reference Docs` workflow and verify CLI docs generate correctly without the flag.
Summary
docs.kosli.com/Hugo site directory (239 tracked files)publish_docs.yml,publish_branch_docs.yml)docs-genjob fromrelease.yml(thedocs-repo-dispatchjob is kept — Mintlify still uses it)cli-docs,legacy-ref-docs,hugo,hugo-local,test_docs,check-links,generate-json-metadata) and associated scriptsinternal/docgen/hugo.go), make Mintlify the default and only doc format.gitignore,.clear-files,.htmltest.yml, README, dev-guide, and release-guidehelm-chart.yml(chart README output is kept)Documentation is now fully maintained in
kosli-dev/docsvia Mintlify.Closes kosli-dev/docs#42
Test plan
go build ./cmd/kosli/succeedsgo test ./internal/docgen/...passes