Skip to content

Three docs pages give instructions that fail: operate/upgrade contradicts deploy/docker, configure/ai imports an unpublished package, help links point to disabled GitHub Discussions #297

Description

@objectstack-fleet

Found by the seat's site-wide audit of docs.objectos.ai on 2026-10-06, which built main @ b754364. Priority: P1. A reader who follows any of these pages hits a dead end, or does something unsafe.

1. operate/upgrade.mdx contradicts deploy/docker.mdx

operate/upgrade.mdx says deploy/docker.mdx:152-166 says
Roll back by "previous container tag" Pin by digest
Uses docker compose -f docker/docker-compose.yml, a layout from the retired @objectos/server repo (not used)
No backup step Back up first
(silent on schema) Rolling the image back does not roll the schema back

Fix: rewrite operate/upgrade.mdx as the Docker page's procedure, or reduce it to a pointer to that procedure. Nothing else may be invented.

2. configure/ai.mdx installs a package that no longer ships

  • configure/ai.mdx:11,34,198 and reference/runtime-capabilities.mdx:30 tell readers to import … from '@objectstack/service-ai'.
  • That package is frozen on npm at 10.3.0, while the CLI is at 17.6.0.
  • The page's source link returns 404, because the folder is gone from the public objectstack repo.

Fix:

  • Remove the install and import instructions that no longer work.
  • Describe AI configuration only as far as a public source documents it: objectstack origin/main README or content docs, or this repo.
  • If the current procedure is not publicly documented, say what is configured where, and raise the gap in the PR body. ⛔ Never cite a private repository.

3. Help links point at a feature that is turned off

  • resources/faq.mdx:218 and resources/support.mdx:10 send readers to GitHub Discussions on this repo, and has_discussions is false.
  • README.md names this repo's issue tracker as the public channel.

Fix: point both links at the issue tracker, or another channel the README names.

Done looks like

Surface

  • content/docs/operate/upgrade.mdx, content/docs/configure/ai.mdx, content/docs/reference/runtime-capabilities.mdx, content/docs/resources/faq.mdx, content/docs/resources/support.mdx (English);
  • their locale siblings, deletion only, under ruling A.

Order

After the P0 card on the single push branch.


Generated by Claude Code

Activity

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

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions