workspace, docs: give each crate a README #200

Merged

natsukium merged 1 commit from docs/crate-readmes into main 2026-10-20 09:13:41 +09:00

Conversation 0 Commits 1 Files changed 23 +111 -48

natsukium commented 2026-10-20 00:52:26 +09:00

Owner

Copy link

Part of #160: crate READMEs for the crates.io and docs.rs pages, and the unsupported cargo install path.

• Every crate under crates/ gets a README describing it as part of felis (tagline from the root README). No stability section: Cargo's 0.x rule already covers it.
• The four crates that speak the IPC wire (protocol, transport, client-core, daemon) say the wire contract is PROTOCOL_MINOR and the minor ledger, not the crate version.
• Each library's crate-level rustdoc is #![doc = include_str!("../README.md")]; the old //! summaries move into the README with repo paths as GitHub links.
• felis-cli / felis-client / felis-daemon READMEs and docs/reference/workspace.md state that cargo install of the three binaries is not a supported install.

Part of #160: crate READMEs for the crates.io and docs.rs pages, and the unsupported `cargo install` path. - Every crate under `crates/` gets a README describing it as part of felis (tagline from the root README). No stability section: Cargo's 0.x rule already covers it. - The four crates that speak the IPC wire (protocol, transport, client-core, daemon) say the wire contract is `PROTOCOL_MINOR` and the minor ledger, not the crate version. - Each library's crate-level rustdoc is `#![doc = include_str!("../README.md")]`; the old `//!` summaries move into the README with repo paths as GitHub links. - felis-cli / felis-client / felis-daemon READMEs and `docs/reference/workspace.md` state that `cargo install` of the three binaries is not a supported install.

natsukium added 1 commit 2026-10-20 00:52:26 +09:00

workspace, docs: give each crate a README that declares its API unstable ... 73e27b74da

crates.io shows a package's README, and docs.rs its crate-level rustdoc;
a published 0.x crate needs both to say that a minor release may break
it and that the wire contract is PROTOCOL_MINOR and the minor ledger,
not the crate version. Each library's crate docs become
include_str!("../README.md"), so the statement has one copy per crate
rather than two, and the old //! summaries move into the README with
repository paths turned into GitHub links.

The binary crates' READMEs and workspace.md say that cargo install of
the three binaries is not a supported install.

Assisted-by: Claude Code

natsukium force-pushed docs/crate-readmes from 73e27b74da to e2f57ac801 2026-10-20 00:54:39 +09:00 Compare

natsukium changed title from workspace, docs: give each crate a README that declares its API unstable to workspace, docs: give each crate a README 2026-10-20 00:54:51 +09:00

natsukium force-pushed docs/crate-readmes from e2f57ac801 to 50e10d61d7 2026-10-20 00:54:52 +09:00 Compare

natsukium force-pushed docs/crate-readmes from 50e10d61d7 to ba2508a3d6 2026-10-20 01:25:57 +09:00 Compare

natsukium merged commit 5b6718ea3c into main 2026-10-20 09:13:41 +09:00

natsukium deleted branch docs/crate-readmes 2026-10-20 09:13:41 +09:00

natsukium referenced this pull request from a commit 2026-10-20 09:13:43 +09:00

Merge pull request 'workspace, docs: give each crate a README' (#200) from docs/crate-readmes into main

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

Area/ci

CI workflows (.forgejo/workflows/)

  

Area/cli

felis-cli crate, the felis front-door binary

  

Area/client

felis-client crate, the winit GUI frontend

  

Area/client-core

felis-client-core crate, shadow screen, config, connect_or_spawn_daemon

  

Area/daemon

felis-daemon crate, session pool, IPC server

  

Area/deps

Dependency bumps

  

Area/docs

Documentation tree when no narrower area fits

  

Area/grid

felis-grid crate, cells, scrollback, image store

  

Area/manual

User-facing docs: tutorials, how-to, user-facing reference pages

  

Area/nix

Nix flake, home-manager module, package definitions

  

Area/protocol

felis-protocol crate, felis.proto, frame layout, version constants

  

Area/pty

felis-pty crate, PTY backends

  

Area/render

felis-render-wgpu crate, GPU pipeline, atlas

  

Area/shaping

felis-shaping crate, swash shaper, font fallback

  

Area/skills

Agent skills (skills/felis, .agents/skills/)

  

Area/transport

felis-transport crate, framing, socket/pipe, SSH carrier

  

Area/vt

felis-vt crate, VT parser, dispatch

  

Compat/Breaking

Breaking change that won't be backward compatible

  

Kind/Bug

Something is not working

  

Kind/Documentation

Documentation changes

  

Kind/Enhancement

Improve existing functionality

  

Kind/Feature

New functionality

  

Kind/Performance

Throughput, latency, or memory cost

  

Kind/Security

This is security issue

  

Kind/Testing

Issue or pull request related to testing

  

perf-regression-accepted

Passes the instruction-count bench gate for an intended cost; state why in a PR comment

  

Reviewed

Confirmed

Issue has been confirmed

  

Reviewed

Duplicate

This issue or pull request already exists

  

Reviewed

Invalid

Invalid issue

  

Reviewed

Won't Fix

This issue won't be fixed

  

Status

Blocked

Something is blocking this issue or pull request

  

Status

Need More Info

Feedback is required to reproduce issue or to continue work

  

Status

Upstream

Waiting on a change in an upstream project

No labels

Area/ci

Area/cli

Area/client

Area/client-core

Area/daemon

Area/deps

Area/docs

Area/grid

Area/manual

Area/nix

Area/protocol

Area/pty

Area/render

Area/shaping

Area/skills

Area/transport

Area/vt

Compat/Breaking

Kind/Bug

Kind/Documentation

Kind/Enhancement

Kind/Feature

Kind/Performance

Kind/Security

Kind/Testing

perf-regression-accepted

Reviewed

Confirmed

Reviewed

Duplicate

Reviewed

Invalid

Reviewed

Won't Fix

Status

Blocked

Status

Need More Info

Status

Upstream

Milestone

Clear milestone

No items

No milestone

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

felis-terminal/felis!200

No description provided.