diff --git a/Cargo.lock b/Cargo.lock index 9516c2c7..9cf07822 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -142,7 +142,7 @@ dependencies = [ "serde", "serde_json", "serde_yaml_ng", - "socketry-markdown 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)", + "socketry-markdown 0.1.0", ] [[package]] @@ -156,7 +156,7 @@ dependencies = [ "bake-releases", "serde", "serde_json", - "socketry-markdown 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)", + "socketry-markdown 0.1.0", "tempfile", "toml_edit", "ureq", @@ -2012,25 +2012,25 @@ dependencies = [ [[package]] name = "socketry-markdown" version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb6b36f84563d391bc2e67e1c8aef731a773acafd4bf4a9c97886f3771133610" dependencies = [ - "criterion", - "env_logger", - "log", - "pretty_assertions", "regex", - "serde", - "serde_json", - "swc_core", "unicode-id", ] [[package]] name = "socketry-markdown" -version = "0.1.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cb6b36f84563d391bc2e67e1c8aef731a773acafd4bf4a9c97886f3771133610" +version = "0.1.1" dependencies = [ + "criterion", + "env_logger", + "log", + "pretty_assertions", "regex", + "serde", + "serde_json", + "swc_core", "unicode-id", ] diff --git a/Cargo.toml b/Cargo.toml index a9e605b5..bc03df54 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -40,7 +40,7 @@ name = "socketry-markdown" readme = "readme.md" repository = "https://github.com/socketry/socketry-markdown-rust" rust-version = "1.73" -version = "0.1.0" +version = "0.1.1" [workspace] members = ["generate", "bake"] diff --git a/agents.md b/agents.md index 68b3806f..8be6d0de 100644 --- a/agents.md +++ b/agents.md @@ -4,102 +4,8 @@ - [Markdown Parser Architecture](context/markdown-architecture.md) — parser, AST renderer, serializer, and test-corpus structure. -## Context +## Agent Context -This section links to documentation from installed packages. It is automatically generated and can be refreshed with `cargo bake agent:context:install`. - -**Before working on a package, read the relevant context files below. They contain package-specific guidance and workflows.** - -If these files are missing or dependencies have changed, run `cargo bake agent:context:install` to install them. - -### bake - -Composable, typed development tasks for Rust projects - -#### [Design](.agents/context/bake/design.md) - -The cargo-bake executable asks Cargo for workspace metadata, identifies an unpublished task binary, and runs it. - -#### [Development Context](.agents/context/bake/development.md) - -This guide summarizes the implementation and task composition in the Bake repository. - -#### [Structuring Bake Tasks in Crates](.agents/context/bake/task-libraries.md) - -Bake has two common places for task functions: - -### bake-agent-context - -Install context files from Cargo dependencies for coding agents - -#### [Getting Started](.agents/context/bake-agent-context/getting-started.md) - -This guide shows how to add Bake Agent Context tasks to a Rust project and install context from its Cargo dependencies. - -#### [Using and Providing Context](.agents/context/bake-agent-context/usage.md) - -Use Bake Agent Context to discover and install practical guidance shipped in dependency crates. - -#### [Rust agent context](.agents/context/bake-agent-context/rust.md) - -Use this shared guidance when working on Socketry's Rust crates. - -#### [Agent Context Specification](.agents/context/bake-agent-context/specification.md) - -Agent Context is a language-agnostic specification for providing and consuming contextual information from software packages to assist AI agents and other automated tools. - -### bake-cargo - -Cargo project and release automation tasks for Bake - -#### [Cargo Publishing](.agents/context/bake-cargo/publishing.md) - -Use `bake-cargo` to prepare and publish Cargo projects through reviewed GitHub Actions releases. - -### bake-readme - -Reusable readme.md maintenance tasks for Bake - -#### [Readme Structure](.agents/context/bake-readme/readme-structure.md) - -Use this guidance when creating or updating a project's `readme.md`. - -### bake-test-rust - -Reusable Rust test tasks for Bake - -#### [Rust Testing Tasks](.agents/context/bake-test-rust/testing.md) - -Add `bake-test-rust` as a dependency of the private `bake/` package and link it from `bake/src/main.rs`: - -### socketry-project - -Shared project conventions and development tasks for Socketry Rust crates - -#### [Agent Context](.agents/context/socketry-project/agent-context.md) - -Distribute useful package guidance with the package, and keep repository-only instructions with the repository. - -#### [GitHub Repository Setup](.agents/context/socketry-project/github-repository.md) - -Use these defaults when creating a Socketry repository. - -#### [Socketry Rust Project Conventions](.agents/context/socketry-project/project-conventions.md) - -Use these conventions for Rust repositories in the Socketry organization. - -#### [Rust Project Layout](.agents/context/socketry-project/project-layout.md) - -Use Cargo's standard structure so contributors can find package code, tests, examples, and project documentation quickly. - -#### [Set Up a Socketry Rust Project](.agents/context/socketry-project/project-setup.md) - -Use this guide to start a Rust repository with the shared Socketry conventions, agent context, and release tasks. - -#### [Pull Requests](.agents/context/socketry-project/pull-requests.md) - -Use these conventions when preparing commits or pull requests for Socketry Rust projects. - -#### [Rust Testing](.agents/context/socketry-project/testing.md) - -Use Cargo's built-in test command for Rust tests. +Run `cargo bake agent:context:install` to install context and skills from Cargo +dependencies. Read `.agents/context/index.md` and the skills that apply to the +task. diff --git a/readme.md b/readme.md index a2d8fb56..83ab5912 100644 --- a/readme.md +++ b/readme.md @@ -62,18 +62,16 @@ HTML output escapes raw HTML and omits MDX expressions by default. See the [API documentation](https://docs.rs/socketry-markdown/latest/socketry_markdown/) for parser options, renderer configuration, and AST types. -### Agent Context - -This crate publishes context files for coding agents. Configure Bake Agent -Context in your private `bake/` crate, then run -`cargo bake agent:context:install --package socketry-markdown` to install them -in `.agents/context/` and update `agents.md`. - ## Releases See [releases.md](releases.md) for the full release history. +### v0.1.1 + +- Update agent guidance to install dependency context and skills without + generating `agents.md`. + ### v0.1.0 - Add AST renderers for HTML and Markdown, including Markdown serialization on @@ -94,6 +92,12 @@ See [releases.md](releases.md) for the full release history. Please open an issue or pull request on [GitHub](https://github.com/socketry/socketry-markdown-rust). +### Agent Context + +Run `cargo bake agent:context:install` to install shared context and skills +from Cargo dependencies. Read `.agents/context/index.md` and the skills that +apply to your task. + [badge-build-image]: https://github.com/socketry/socketry-markdown-rust/actions/workflows/test.yml/badge.svg [badge-build-url]: https://github.com/socketry/socketry-markdown-rust/actions [badge-coverage-image]: https://img.shields.io/codecov/c/github/socketry/socketry-markdown-rust.svg diff --git a/releases.md b/releases.md index 11da4db1..72a21fef 100644 --- a/releases.md +++ b/releases.md @@ -1,5 +1,10 @@ # Releases +## v0.1.1 + +- Update agent guidance to install dependency context and skills without + generating `agents.md`. + ## v0.1.0 - Add AST renderers for HTML and Markdown, including Markdown serialization on