Skip to content

Docs: Improve contributor setup guidance#413

Open
skytin1004 wants to merge 1 commit into
Azure:mainfrom
skytin1004:docs-typo-issue-triage
Open

Docs: Improve contributor setup guidance#413
skytin1004 wants to merge 1 commit into
Azure:mainfrom
skytin1004:docs-typo-issue-triage

Conversation

@skytin1004
Copy link
Copy Markdown
Collaborator

Summary

  • Fix README setup wording and link the beginner installation guide.
  • Add a new contributor quick start to CONTRIBUTING with setup, check, fork, and PR links.
  • Rewrite the command-line installation guide into PyPI and repository-clone paths.
  • Clean stale command-line guide wording around Vision configuration and old Markdown-only references.
  • Add a docs regression test for the typo/stale-phrase cluster from Docs: Fix typos and improve documentation #45.

Validation

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

Closes #45

@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.

Docs: Fix typos and improve documentation

1 participant