Skip to content

Rewords the doc_links comment in .quality.exs - #347

Closed
johnnyt wants to merge 1 commit into
mainfrom
st-1kyb-doc-links-comment
Closed

johnnyt wants to merge 1 commit into
mainfrom
st-1kyb-doc-links-comment

Conversation

@johnnyt

@johnnyt johnnyt commented Sep 26, 2026

Copy link
Copy Markdown
Member

Rewords the comment beside the doc_links stage in .quality.exs (st-1kyb).

Draft until the operator fills in Approved-by.

What changed

  • .quality.exs: the comment beside the Docs and Doc links stages said the Doc links stage fails on "a published relative link to a file that is not an extra", which reads as covering moduledoc links too. The stage reads relative links in the Markdown extras and the README only; moduledoc links are the Docs stage's. The comment now carries the same wording as the other packages in the family. No stage option changes.
  • docs/quality-gate-changes.md: the ADR-0011 entry for that edit, with Approved-by: <operator to fill> for the operator to complete. The entry is left for the operator because writing the approval is not an agent's call.

No changelog fragment: the change is gate tooling, which changelog.d/README.md excludes. No version bump.

Evidence

  • mix quality green on the committed tree, placeholder included: Gate guard "No unjustified gate changes", Doc links 37 links checked, Docs no warnings, 3,067 of 3,067 tests passed, 96.3% coverage, Dialyzer clean. The Gate guard checks that an Approved-by: line is present, not what it says, so the placeholder does not turn it red.
  • mix gate.check: no unjustified gate changes.
  • mix quality --profile merge green; the ADR judge skipped because the diff touches none of its judged scopes.

For the operator

Replace the placeholder on the Approved-by: line in docs/quality-gate-changes.md, then mark the PR ready.

The comment beside the Docs and Doc links stages said the Doc links
stage fails on "a published relative link to a file that is not an
extra", which reads as covering moduledoc links too. The stage reads
relative links in the Markdown extras and the README only; moduledoc
links are the Docs stage's. The comment now carries the wording the
other packages in the family use. No stage option changes.

The gate-change log gains the entry the Gate guard requires, with
its Approved-by line left for the operator to fill.

Refs: st-1kyb
@johnnyt

johnnyt commented Sep 29, 2026

Copy link
Copy Markdown
Member Author

Superseded by #351, which carries this change with the operator's approval filled in.

@johnnyt johnnyt closed this Sep 29, 2026
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