Skip to content

Rewrite the README and context guide, incorporating #114 and current 1.5 contracts #128

Description

@jmanico

Reviewed 2026-09-25 (America/Los_Angeles) against main at bd249f5. Execution order and cross-issue ownership: #169. Batch 05.

This scope replaces the dated implementation prescriptions in the original report and earlier comments; linked historical evidence remains useful but must be rechecked before implementation.

Canonical README work item

Absorbs #114's remaining work. #162 already supplied runtime compatibility documentation; #151 added JSON and #155 added ordinary untagged-template support. The new guide must describe those contracts, not historical statements that JSON/templates are categorically unsupported. #112 owns urgent ESAPI dependency/release wording first.

Batch 01 migration input

#100 and #130 are complete through #170 and #172. Reuse the shared forUri migration section and release-specific ESAPI URL/context guidance in the future README consolidation. Preserve the distinction between legacy retained forUri behavior, the adapter's unreleased 1.5 component-encoding change, ESAPI form encoding, application URL validation, and quoted HTML/CSS/JavaScript contexts. Adapter null/Unicode behavior and upstream security support remain explicitly documented. This input does not complete the broader #128 scope.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: docsConsumer/contributor documentation and project metadata.documentationpriority: P2Planned maintenance; follow the ordered batch and documented dependencies.security-reviewSecurity-sensitive scope or acceptance criteria; not a vulnerability classification.triage: depends-onFollow the explicit predecessor/coverage/tooling dependencies in the issue.

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions