Skip to content

docs: reorganize project documentation - #9

Merged
dKosarevsky merged 4 commits into
mainfrom
codex/documentation-reorganization
Aug 31, 2026
Merged

dKosarevsky merged 4 commits into
mainfrom
codex/documentation-reorganization

Conversation

@dKosarevsky

Copy link
Copy Markdown
Collaborator

Summary

  • keep the root README concise and route detailed guidance to dedicated docs
  • move localized READMEs to docs/i18n while preserving the current alpha installation lifecycle
  • add a benchmark guide and public Markdown, link, and package contracts

Test plan

  • uv run pytest -q (2780 passed, 2 skipped)
  • uv run ruff format --check .
  • uv run ruff check .
  • uv run mypy src
  • uv build with wheel and sdist metadata inspection

if added 4 commits August 31, 2026 11:39
…eorganization

# Conflicts:
#	README.el.md
#	README.grc-x-laconian.md
#	README.it.md
#	README.md
#	README.ru.md
#	README.zh-CN.md
#	tests/test_public_contract.py
@dKosarevsky
dKosarevsky merged commit 5280856 into main Aug 31, 2026
3 checks passed
@dKosarevsky
dKosarevsky deleted the codex/documentation-reorganization branch August 31, 2026 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant