Skip to content

docs: rewrite README for current CLI surface and agent optimization#54

Merged
iamfj merged 2 commits into
nextfrom
readme
Feb 20, 2026
Merged

docs: rewrite README for current CLI surface and agent optimization#54
iamfj merged 2 commits into
nextfrom
readme

Conversation

@iamfj
Copy link
Copy Markdown
Member

@iamfj iamfj commented Feb 20, 2026

Summary

  • Rewrites README to match the current CLI surface after the v2 architecture refactor
  • Highlights Linearis as optimized for LLM agents with a discover-then-act workflow and MCP comparison table
  • Updates all stale command names (embeds -> files, --label-by -> --label-mode, --around-active -> --window, --attach-to -> --issue, search -> list --query)
  • Adds missing features: issue relations, milestones, cursor pagination
  • Replaces generic agent rule with a prompt-engineered example optimized for agent instruction sets
  • Adds maintainer section (Fabian Jocks) alongside original author (Carlo Zottmann), preserving sponsoring and project links

iamfj and others added 2 commits February 20, 2026 13:56
Introduced a new skill for crafting effective README files, including
various templates for open source, personal, internal projects, and
configuration directories. Added a section checklist for project types
and style guide to enhance documentation quality.

New files include:
- section-checklist.md
- SKILL.md
- style-guide.md
- using-references.md
- multiple reference documents
- templates for different project types

This skill aims to provide comprehensive guidance for creating
informative and user-friendly README files.
Update all command examples to match renamed commands (files, --label-mode,
--window, --issue, --query). Add missing features: issue relations,
milestones, cursor pagination. Expand LLM agent section with
discover-then-act workflow, MCP comparison table, and optimized example
prompt. Add maintainer section for Fabian Jocks alongside original author
Carlo Zottmann.

Co-Authored-By: claude-opus-4-6 <noreply@anthropic.com>
@iamfj iamfj self-assigned this Feb 20, 2026
@iamfj iamfj merged commit c960e05 into next Feb 20, 2026
2 checks passed
@iamfj iamfj mentioned this pull request Feb 20, 2026
12 tasks
iamfj added a commit that referenced this pull request Apr 7, 2026
Rewrite all documentation to reflect the new five-layer architecture,
updated CLI surface, and current development workflows.

- AGENTS.md: restructure for machine-first readability with decision
  trees, anti-patterns, and layer invariants
- README.md: rewrite for current CLI commands and agent optimization
- docs/architecture.md: document five-layer component organization
- docs/development.md: add service/resolver/command templates
- docs/testing.md: add mock patterns per layer
- docs/build-system.md: document codegen pipeline
- docs/files.md: update file catalog for new structure

Remove obsolete files:
- docs/Linear-API@current.graphql (26k-line schema dump)
- docs/plans/ (completed implementation plans)

Part of #45
Refs #54
@iamfj iamfj deleted the readme branch April 21, 2026 21:16
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