Skip to content

Docs: Consolidate getting started references#414

Open
skytin1004 wants to merge 1 commit into
Azure:mainfrom
skytin1004:consolidate-docs-navigation
Open

Docs: Consolidate getting started references#414
skytin1004 wants to merge 1 commit into
Azure:mainfrom
skytin1004:consolidate-docs-navigation

Conversation

@skytin1004
Copy link
Copy Markdown
Collaborator

Summary

  • Point README and getting_started pages at the MkDocs pages that now own full CLI, configuration, API, and examples reference material.
  • Shorten duplicated command-line walkthrough content so it stays as an entry path instead of a second source of truth.
  • Update GitHub Actions guides to remove stale Markdown-only and set-up-resources links, and make the default workflow text-only unless image translation is explicitly configured.
  • Add a docs consistency regression test for canonical links, stale flags, and missing relative links.

Validation

  • python -m black --check tests/co_op_translator/test_docs_consistency.py
  • python -m ruff check tests/co_op_translator/test_docs_consistency.py
  • python -m pytest tests/co_op_translator/test_docs_consistency.py -q
  • mkdocs build --strict
  • git diff --check

@github-actions github-actions Bot added documentation Improvements or additions to documentation tests labels May 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant