Skip to content

Describe the new marfa docs behavior once the release carries it #588

Closed

Description

@aicayzer

Summary

When the next marfa release carries the marfa docs changes, the pages that describe the command should say what it now does: help after a search that finds nothing, reading one section of a page, and safe printing on a terminal. Until then the pages stay as they are, because they describe the released command.

Context

Marfa pull request withmarfa/marfa#2317 changes marfa docs (issue withmarfa/marfa#2312). The command reference is synced from a marfa release tag, and the CI check for documented commands (this repository, src/lib/command-check.ts) rejects an option that the synced reference does not list, so a page cannot describe the new options before the release. The docs MCP server already offers the same section option on docs_fetch (merged in this repository).

Acceptance criteria

  • The Docs as Markdown page and the CLI page describe the miss help, the section option and the safe printing, as the released command behaves.
  • The command-check test passes against the synced release.
  • The pages around them (docs MCP server, any guide that shows marfa docs) agree.

Out of scope

Notes

Blocked by withmarfa/marfa#2312 reaching a release and the sync pull request for that release.

Activity

  1. added
    needs-triageNot yet confirmed and prioritized; do not build from it
    on Oct 22, 2026
  2. added theissue type on Oct 22, 2026
  3. aicayzer commented on Oct 23, 2026

    @aicayzer
    ContributorAuthor

    Done. Marfa v0.0.27 carries the marfa docs changes. The Docs as Markdown page ("Search from a terminal") and the CLI page describe the miss help, --section and safe terminal printing as the command behaves at the tag, from #589 and #591, which synced the release and corrected the pages against the code. The command check passes against the synced release.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    needs-triageNot yet confirmed and prioritized; do not build from it

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions