docs: mark stale docs/dev/ design notes as outdated - #1483
Conversation
docs/dev/ has no currency signal, so contributors and coding agents can follow a design note as if it reflects current behaviour when it does not. Add a short status banner to each file confirmed stale or unfinished during an audit against current source: - intrinsics_and_adapters.md: predates Epic generative-computing#929's capability-based adapter model; rewrite tracked in generative-computing#1144 - tool_calling.md: proposes a SessionToolCallingProtocol mixin that was never implemented; the shipped example uses unrelated ad hoc classes - mify.md: example code does not run as written, and the implementation path it cites has moved; points readers to the published replacement and the working example - spans.md: unfinished stub with no SpanContext in the codebase; notes that the old /dev/spans redirect now points to an unrelated page - constrained_decoding.md: informal brainstorm with no recorded decision - mellea_library.md: philosophy statement, not re-verified line-by-line generate_ctx_signature.md, hook_system.md, and requirement_aLoRA_rerouting.md were checked against source and left unchanged; they still match current code. Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
AGENTS.md's directory structure table had no entry for docs/dev/ at all, so an agent had no way to learn from AGENTS.md that the directory exists or that its contents aren't maintained documentation. Add a row plus an explicit warning telling agents/contributors to check for a status banner and verify claims against source before relying on a docs/dev/ note. Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
|
cc @ajbozarth — following up on our discussion about the OTel-on-adapters mis-step (#1464): the root cause there was a stale |
Follow-up from a self-review of the status banners added in this PR: - mify.md's own bottom-of-file links were still pointing at the old paths (examples/mify.py, stdlib/mify.py) even though the new banner above them gives the correct ones; fix them to match, and note the second example's undefined `c` (should be `customer`) in the banner. - constrained_decoding.md's banner said "unattributed suggestions" but the note actually names Hendrik/Nathan/Masataro; reworded to "informally paraphrased" to avoid the inaccurate claim. Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
|
This feels a bit more like a bandaid, I think the better solution would be cleaning up old unneeded docs and investigating the good docs for a potential move actual docs. Either way the AGENTS update is probably good. We could also both clean it up and potentially reframe the dir's intent to be docs mean for AI consumption not public and then keep them up to data and keep pitches/plans out of that dir. No matter what I think we need to decide as a team what the intent of |
Pull Request
Issue
Ref #1482
Description
Related to #1482 — adds a short status banner to each
docs/dev/design note confirmed stale or unfinished during a source-level audit, so contributors and coding agents don't mistake it for current behaviour. No code changes; docs only.Banners added:
intrinsics_and_adapters.md— predates Epic Epic: Fix Adapter Function Lifecycle & Consistency in Mellea #929's capability-based adapter model; rewrite already tracked in refactor(intrinsics): remove deprecation shims; rewrite intrinsics_and_adapters.md; write 3 tutorials (Epic #929 Phase 4) #1144tool_calling.md— proposes aSessionToolCallingProtocolmixin that was never implemented; the shipped example (docs/examples/agents/react/react_from_scratch/react.py) uses unrelated ad hoc classes insteadmify.md— example code doesn't run as written, and the implementation path it cites has moved; points readers to the publisheddocs/docs/concepts/mobjects-and-mify.mdand the working examplespans.md— unfinished stub, breaks off mid-decision; noSpanContextexists in the codebase; notes that the old/dev/spansredirect now points to an unrelated OpenTelemetry tracing pageconstrained_decoding.md— informal brainstorm with no recorded decisionmellea_library.md— philosophy statement, not re-verified line-by-line against current codegenerate_ctx_signature.md,hook_system.md, andrequirement_aLoRA_rerouting.mdwere checked against source and left unchanged — they still match current code.Also adds a
docs/dev/row toAGENTS.md's directory structure table, plus a guardrail telling agents/contributors to check for a status banner and verify claims against source before relying on a note from this directory —AGENTS.mdpreviously didn't mentiondocs/dev/at all, so there was no way to learn from it that the directory exists or that its contents aren't maintained documentation.This is a starting point for the discussion in #1482, not a final policy. Opening as a draft since #1482 is still open for discussion on the right long-term approach (banners vs. archiving vs. folding into published docs, etc.) — happy to adjust scope based on how that lands.
Testing
Attribution
Adding a new component, requirement, sampling strategy, or tool?
If your PR adds or modifies one of the types below, check the matching box. A checklist of type-specific review items will be posted as a comment.
NOTE: Please ensure you have an issue that has been acknowledged by a core contributor and routed you to open a pull request against this repository. Otherwise, please open an issue before continuing with this pull request.