Skip to content

Refresh the Markdown agent context entrypoint. #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samuel-williams-shopify merged 1 commit into from
Oct 3, 2026
Merged

Refresh the Markdown agent context entrypoint. #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down
102 changes: 4 additions & 98 deletions agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
18 changes: 11 additions & 7 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!-- bake-readme:releases:start -->
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
Expand All @@ -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
Expand Down
5 changes: 5 additions & 0 deletions releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading