Skip to content

docs(contributing): spell out KTLO where it is defined and link its earlier mentions (#1950) - #1951

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1950-ktlo-expansion
Oct 19, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1950-ktlo-expansion

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description of your pull request and other information

Spells out KTLO (keep the lights on) where workflows.rst defines the tier, labels it ktlo-tier, and links each contributor page's first mention to it (workflows.rst, releasing.rst). Job names such as (KTLO) stay literal, and no Markdown file uses the acronym.

tests/project/test_docs_ktlo_defined_1950_unit.py pins the expansion under the label and each page's first-mention link, and fails on main. The docs build has no warnings.

Closes #1950

…arlier mentions (#1950)

- workflows.rst: expand KTLO as "keep the lights on" in the tier paragraph and
  label it ktlo-tier; link the page's first mention, which precedes it.
- releasing.rst: link the page's first KTLO mention to that label.
- tests: pin the expansion under the label, and that each page's first prose
  mention links there or follows the definition; Markdown spells it out.

Closes #1950
@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) review: running A cross-review is in flight against the current head - no verdict yet labels Oct 19, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

GOOD TO GO at 878ffb359. A Sonnet review built the docs with 0 warnings. The ktlo-tier anchor lands on the tier paragraph, and both :ref: links render as "KTLO". workflows.rst and releasing.rst are the only places KTLO appears, and each links its first prose mention. The new test fails on main's two pages (4 of 4). The version-updater tests still pass.

@JarryShaw JarryShaw added review: good-to-go Cross-review at the current head says ready; CI state is separate and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 19, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 19, 2026
@JarryShaw
JarryShaw merged commit f1ae325 into main Oct 19, 2026
46 of 51 checks passed
@JarryShaw
JarryShaw deleted the docs/1950-ktlo-expansion branch October 19, 2026 18:51
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 19, 2026
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 19, 2026
@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Pull requests that change documentation only (docs: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

docs(contributing): spell out KTLO where it is defined and link its earlier mentions

1 participant