Skip to content

Align developer documentation with current behavior - #354

Merged
mintuhouse merged 1 commit into
mainfrom
mintuhouse/docs-consistency
Oct 23, 2026
Merged

mintuhouse merged 1 commit into
mainfrom
mintuhouse/docs-consistency

Conversation

@mintuhouse

Copy link
Copy Markdown
Contributor
  • Consolidate native contributor setup, remove the devcontainer option, and replace duplicated commands with canonical guides.
  • Align SDK, CLI, API, dashboard, and self-hosting documentation with current authorization, lifecycle, storage, and operational behavior. Fix copy-paste examples and misleading CLI help.
  • Preserve section fragments in relative documentation links and keep internal navigation in the current tab.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-23T16:44:41.074351Z c916b79 PR opened
🔒 Security Review ✅ Completed 2026-10-23T16:45:28.787572Z c916b79 PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@mintuhouse

mintuhouse commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor Author

Validation results for head c916b794114deb582945590e982262188435f8d1:

  • All 12 hosted checks passed, including full Platform unit/integration tests, builds, and security checks. Codex code and security reviews completed with no findings, and there are no unresolved review threads.
  • Platform formatting, generated OpenAPI, typed lint, unused-code checks, and production build passed locally. CLI ready passed, including 15 tests. SDK build and CLI help smoke checks passed.
  • The initial local Platform test run had 534 passing tests, 140 skipped, and four timeouts in two unchanged files. A serial rerun with pinned Bun 1.4.4 passed all 18 tests in those files in 8.78 seconds. The initial shell had selected Bun 1.4.3.
  • Root formatting and git diff --check passed. Three parallel source reviews completed without outstanding findings. No new tests were added.
  • Platform browser suite: 13 passed and one unchanged profile-files test timed out after 60 seconds (7.8 minutes total). Trace inspection showed successful avatar/logo checks followed by cumulative UI waits exhausting the test budget. Initial report retained at /tmp/astralbeam-docs-pr-yTEY2x/platform-e2e-initial/report. A focused retry was stopped at the maintainer's request to keep validation proportional to this documentation change.
  • Todos deterministic browser suite: 65 passed and one inherited harness failure (6.5 minutes). json: Response has been disposed occurred at examples/todos/e2e/specs/app/directory-cache.spec.ts:207 during teardown, after the final hostErrors === 0 assertion passed. The test, listings implementation, and lockfile match the base. This matches the previously documented failure. Report: examples/todos/e2e/.output/report.
  • Focused browser navigation verified relative section links, internal API navigation, and external-link attributes. The attached walkthrough was reviewed before upload and contains no credentials.

Fresh-machine setup and deployed/live-provider behavior were not exercised.

docs-navigation

@mintuhouse
mintuhouse merged commit f200d41 into main Oct 23, 2026
12 checks passed
@mintuhouse
mintuhouse deleted the mintuhouse/docs-consistency branch October 23, 2026 16:56
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