Docs: bundle providers (API, capability model, per-backend READMEs, CLAUDE.md dependency rules)

Open
#143 3 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
csharp, github-actions, markdown
Domain
documentation

Research direction

Start by searching the repository for claims that bundles must be local directories, including test names and [Description] strings. Update the listed READMEs, CLAUDE.md, CHANGELOG.md, and ROADMAP.md as the provider work in #139–#142 lands; run each provider README’s commands and use the update-website workflow when a provider ships. Done means the claims and dependency rules are accurate throughout, and the documented commands have been executed.

Written by the indexing model from the issue text.

Description

documentation

Area

Documentation for the bundle provider work: #139 (seam), #140 (filesystem), #141 (embedded resources), #142 (S3).

Why it matters

Several documents currently state, as a fact, that a bundle is a local directory — the Catalog README says "Local filesystem bundles only — no remote/HTTP sources" — and CLAUDE.md's dependency rules list every project and what it may reference. Once the seam lands those statements become false, and a new backend project with a third-party dependency (S3) needs its exception written down where the rule lives. Corrections must be propagated everywhere the claim appears, not in one place.

Scope

  • README.md: how to load a bundle from a provider; the capability model (read required, write declared); the read-only exception; the breaking API changes from #139 (no more absolute paths in Concept.Path / resource resolution).
  • src/OKF4net.Agents/README.md: how OkfBundleTools / OkfContextProvider take a provider; how provider capability combines with OkfToolMode (effective write = CanWrite && mode != ReadOnly).
  • src/OKF4net.Catalog/README.md (remove the "local filesystem only" limitation as each backend lands), src/OKF4net.Catalog.Hosting/README.md (registration), src/OKF4net.Mcp/README.md (choosing a provider for okf-mcp), src/OKF4net.Attestation/README.md (sanctioned files read through the provider).
  • One README per new provider project (#141, #142): configuration, capabilities, security notes, how to run its integration tests locally.
  • CLAUDE.md: architecture entries for the seam and each provider project; dependency-rule entry for each provider project (zero-dep for embedded resources; explicit exception for S3).
  • CHANGELOG.md (breaking change), ROADMAP.md (provider items moved/closed), NOTICE if a provider brings third-party material.
  • Project website (web/), via the update-website workflow, once a provider ships in a release.

Acceptance

  • Every statement that a bundle must be a local directory is found (search the bare terms, including test names and [Description] strings that ship) and corrected or scoped to the filesystem provider.
  • Each provider README's commands are executed once, not just written.

Depends on

#139; then updated as #140, #141 and #142 land.

Effort

S per backend, M overall.


🤖 Generated with Claude Code

Dominant language
C#
Stars
4
Forks
1
Avg merge
1d 4h
Merged PRs (30d)
32

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jchable/okf4net

All issues in jchable/okf4net

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.