Skip to content

Consolidate task environment docs under Supported Tasks - #854

Merged
yuecideng merged 1 commit into
mainfrom
codex/docs-consolidate-task-entry
Oct 24, 2026
Merged

yuecideng merged 1 commit into
mainfrom
codex/docs-consolidate-task-entry

Conversation

@yuecideng

Copy link
Copy Markdown
Contributor

Description

Consolidate task discovery, preview, and authoring guidance in Resources → Supported Tasks, removing the duplicate Getting Started → Task Environments entry. Update the README and generated introduction to use the task resource page, and retain the former quick-start URL as an orphan redirect with a fallback link.

Dependencies: none. No linked issue.

Type of change

  • Documentation update

Validation

  • black . with Black 26.10.1: 1,535 files unchanged.
  • python docs/scripts/check_api_docs.py: 3,045/3,045 exports documented.
  • python docs/scripts/sync_readme.py --check: passed.
  • Sphinx HTML build with -D autosummary_generate=0: completed; none of the changed pages emitted warnings. Checked the generated navigation, merged sections, local guide links, introduction link, and redirect fallback.
  • Opened the former URL in a browser and verified automatic navigation to resources/task/index.html.
  • The default Sphinx build could not complete API autosummary generation because this environment lacks simulator/runtime dependencies, including dexsim.engine. The content build still reports warnings in unrelated API/example sources.
  • No Python tests added or run: this changes documentation content and navigation only; Sphinx and generated HTML/browser checks cover the affected behavior.

Checklist

  • I have run the black . command to format the code base.
  • I reviewed affected documentation and agent context. context.py affected --base origin/main --explain reports no affected topics; runtime and architecture guidance remain accurate.
  • Public API documentation coverage passes; no public APIs changed.
  • I verified appropriate behavioral coverage and reviewed test necessity; no new tests are needed for this documentation-only change.
  • No dependency updates are needed.

@yuecideng yuecideng added the docs Documentation, API references and example explanations. label Oct 24, 2026
@yuecideng
yuecideng merged commit 8ad8ac4 into main Oct 24, 2026
6 of 8 checks passed
@yuecideng
yuecideng deleted the codex/docs-consolidate-task-entry branch October 24, 2026 12:28
@greptile-apps

greptile-apps Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The documentation changes appear safe to merge.

Summary

Consolidates task discovery, preview, and authoring guidance under Resources → Supported Tasks.

  • Supported Tasks brings task discovery, preview, and authoring guidance together.

No actionable issues found.

Reviews (1) · Last reviewed commit: "docs(tasks): consolidate task environmen..." · Reviewed by Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation, API references and example explanations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant