Skip to content

Document the initial public API and scope #2

Closed

Description

@zonuexe

Provide a guide for generating public API Markdown and running lint without Rigor. Rigor lens integration and formatting follow 0.0.1.

Acceptance criteria

  • Show installation, parse/render APIs, and CLI directory/stdin input.
  • Explain documentation markers, multiline descriptions, main tags, and contract/API documentation separation.
  • Explain the versioned model, diagnostics, SourceSpan, and API compatibility.
  • Document exit codes, --fail-on warning, and rendering errors without partial Markdown.
  • State supported Ruby versions, UTF-8 requirements, visibility rules, and static analysis limits; runtime name resolution and Rigor claim checking are outside this release.
  • Run examples and confirm their documented output.

Dependencies: none.

Status

Completed in #7 after Sol approval and CI.

Activity

  1. added this to the v0.0.1 milestone on Oct 8, 2026
  2. changed the title [-]初回リリースの記法・公開API・対応範囲を文書化する[/-] [+]Document the initial public API and scope[/+] on Oct 8, 2026
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

    ready-for-agentScoped work ready for an agent

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions