docs: refresh README for the openadapt-ops rename and docs pipeline#54
Merged
Conversation
Reframe the root README around what this repository now is: the source of truth for docs.openadapt.ai plus the ops automation that builds, validates, and publishes it. Note the former openadapt-maintenance name, describe the docs/, scripts/, tidy/, and repos.yml layout, give the local build/serve/ validate commands, and document the CI gate and the push-to-main plus dispatch/schedule GitHub Pages publish flow. Add the shared OpenAdapt positioning and cross-links to the flagship repo and live docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NyCHrzA1psrKMFfroYbzaM
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Refreshes the root
README.mdto reflect what this repository actually is today: the source of truth for docs.openadapt.ai plus the ops automation that builds, validates, and publishes it.Changes
openadapt-maintenancename (nowOpenAdaptAI/openadapt-ops).docs/+mkdocs.yml(curated MkDocs Material site),scripts/(sync + validate pipeline),tidy/(history/artifact scrubbing CLI),repos.yml.uv run mkdocs serve,mkdocs build --strict,scripts/validate_docs.py, andpytest tests/.ci.yml: tests + validate + strict build on PR/push) and the publish flow (sync.yml: deploys to GitHub Pages at docs.openadapt.ai on push-to-main touching docs, on sub-repo dispatch, and on the weekly/manual rebuild).Scope / safety
git difftouches onlyREADME.md). The README lives at repo root, outside thedocs/tree thatvalidate_docs.pyand the mkdocs build consume, so the docs gates are unaffected.validate_docs.pypasses,pytest tests/ -q= 64 passed,mkdocs build --strictsucceeds.🤖 Generated with Claude Code
https://claude.ai/code/session_01NyCHrzA1psrKMFfroYbzaM