Skip to content

[codex] Slim README docs split#26

Merged
dd3ok merged 3 commits into
mainfrom
codex/readme-docs-slim
Jun 15, 2026
Merged

[codex] Slim README docs split#26
dd3ok merged 3 commits into
mainfrom
codex/readme-docs-slim

Conversation

@dd3ok

@dd3ok dd3ok commented Jun 15, 2026

Copy link
Copy Markdown
Owner

Summary

  • Slim README.md and README.ko.md into short landing pages with quickstart, runtime boundary, and docs links.
  • Move detailed install, storage/privacy, validation, and release guidance into repo-only docs.
  • Update policy markers and unit tests so README stays lightweight while moved details remain covered.

Runtime weight

  • No changes under .agents/skills/watchlist-md/.
  • The installable runtime skill remains Python-free and does not gain validators, scripts, smoke logs, or eval corpora.

Validation

  • PYTHONDONTWRITEBYTECODE=1 python -m unittest discover -s evals -p 'test_*.py'
  • python evals/check_policy_markers.py
  • python evals/check_semantic_cases.py
  • python evals/check_skill_package.py
  • python evals/check_release_metadata.py
  • python evals/check_watchlist.py examples/WATCHLIST.example.md
  • python evals/check_watchlist.py examples/WATCHLIST.example.md --strict-format --strict-safety --require-archive-section
  • python evals/check_watchlist.py .agents/skills/watchlist-md/assets/WATCHLIST.template.md
  • python tools/validate_watchlist.py .agents/skills/watchlist-md/assets/WATCHLIST.template.md --strict-format --strict-safety --require-archive-section
  • git diff --name-only origin/main...HEAD -- .agents/skills/watchlist-md returned no paths.
  • git diff --name-only -- .agents/skills/watchlist-md returned no paths.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request restructures the project's documentation by simplifying the English and Korean README files into concise landing pages and moving detailed guides (installation, storage/privacy, validation, and release checklists) into dedicated files under the docs/ directory. Corresponding updates were made to the policy markers and test suite. Feedback on the changes suggests refactoring the test suite to better align with this new structure by moving README-specific assertions to their appropriate test case and cleaning up unused variables in the storage policy test.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread evals/test_check_watchlist.py
Comment thread evals/test_check_watchlist.py Outdated
@dd3ok dd3ok marked this pull request as ready for review June 15, 2026 11:53

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3206c3c404

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/install.md
Comment thread docs/maintainers/release.md
@dd3ok dd3ok merged commit e3e804b into main Jun 15, 2026
4 checks passed
@dd3ok dd3ok deleted the codex/readme-docs-slim branch June 15, 2026 23:10
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