Skip to content

[Bugfix] Align module docs with current CLI surface#92

Merged
djm81 merged 2 commits intodevfrom
bugfix/docs-cli-command-alignment
Mar 17, 2026
Merged

[Bugfix] Align module docs with current CLI surface#92
djm81 merged 2 commits intodevfrom
bugfix/docs-cli-command-alignment

Conversation

@djm81
Copy link
Contributor

@djm81 djm81 commented Mar 17, 2026

Summary

  • align docs examples with the current mounted CLI surface and official nold-ai module ids
  • replace broken legacy workflow pages with explicit legacy notices when no current public mounted replacement exists
  • add an OpenSpec change documenting the docs alignment requirement

Verification

  • openspec validate docs-cli-command-alignment --strict
  • hatch run specfact --help
  • hatch run specfact project sync bridge --help
  • hatch run specfact code validate sidecar --help
  • hatch run specfact code repro --help
  • hatch run specfact spec validate --help
  • hatch run specfact govern enforce --help
  • pre-commit hooks run during git commit

@djm81 djm81 self-assigned this Mar 17, 2026
@djm81 djm81 added the documentation Improvements or additions to documentation label Mar 17, 2026
@djm81 djm81 merged commit 614c82d into dev Mar 17, 2026
8 checks passed
Copy link

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

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: 9142d0b7ee

ℹ️ 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 on lines 505 to +506
# Set enforcement level
specfact enforce stage --preset balanced
specfact govern enforce stage --help

Choose a reason for hiding this comment

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

P2 Badge Use an executable enforcement command in quickstart

The quickstart block labels this step as “Set enforcement level” but the command now uses --help, which only prints usage and does not persist any enforcement preset. In a fresh setup, users following this section will believe enforcement is configured when it is still at defaults, so subsequent validation behavior can be unexpected. This should be an executable example (for example with --preset) rather than a help invocation.

Useful? React with 👍 / 👎.

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant