Skip to content

docs: lead the repository with the disagreement loop - #194

Merged
bluejeans117 merged 3 commits into
mainfrom
docs/disagreement-storefront
Sep 22, 2026
Merged

bluejeans117 merged 3 commits into
mainfrom
docs/disagreement-storefront

Conversation

@bluejeans117

Copy link
Copy Markdown
Collaborator

Summary

  • The README now opens with the runtime-versus-contract disagreement, the flexdoc validate result, and the path from the finding into the API Client, ahead of the package matrix.
  • The Express example is the evaluation path: acknowledged GET /internal/health does not fail validation, and unacknowledged POST /internal/reindex does. Its login route sits under /docs so discovery does not report a third undocumented route.
  • The root LICENSE is the standard Apache-2.0 text, with the copyright notice in the appendix, so GitHub can identify the license.

Test plan

  • node scripts/check-example-versions.mjs
  • node scripts/check-release-doc-version-claims.mjs
  • CI on this pull request
  • GitHub repository license shows Apache-2.0 after merge

The published product compares registered routes with OpenAPI. The README and the Express example now say that first, and the license file is the standard Apache-2.0 text GitHub can recognize.

Signed-off-by: Vishnu R <vishnurajesh45@gmail.com>
…canonical

The evaluation path moved login under /docs, which is outside runtime discovery. The license file is the unmodified Apache-2.0 text again, and the copyright notice lives in NOTICE. The README limits the 3.5 validation loop to Node.

Signed-off-by: Vishnu R <vishnurajesh45@gmail.com>
NOTICE already carries dependency attributions. The FlexDoc copyright is added at the top instead of replacing that file.

Signed-off-by: Vishnu R <vishnurajesh45@gmail.com>
@bluejeans117
bluejeans117 merged commit ffa464e into main Sep 22, 2026
4 checks passed
@bluejeans117
bluejeans117 deleted the docs/disagreement-storefront branch September 22, 2026 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant