Skip to content

[docs-comments-cleanup] Canonicalize PMM text policy#282

Merged
netkeep80 merged 2 commits intonetkeep80:mainfrom
konard:issue-281-c82b29459bf5
Apr 18, 2026
Merged

[docs-comments-cleanup] Canonicalize PMM text policy#282
netkeep80 merged 2 commits intonetkeep80:mainfrom
konard:issue-281-c82b29459bf5

Conversation

@konard
Copy link
Copy Markdown
Contributor

@konard konard commented Apr 18, 2026

Summary

  • Make docs/comment_policy.md the canonical policy for PMM comments, documentation placement, and text-surface review.
  • Replace duplicated comment-policy details in CONTRIBUTING.md with links to canonical docs.
  • Update docs/index.md navigation text for the expanded policy role.

Fixes #281

Surface delta

  • Changed docs: CONTRIBUTING.md, docs/comment_policy.md, docs/index.md
  • New markdown files: 0
  • Removed duplicated lines: CONTRIBUTING.md no longer repeats the comment type/prohibited-pattern table
  • Net markdown delta: 55 insertions / 56 deletions, net -1 line
  • Code surface: untouched
  • Generated surface: untouched

Verification

  • scripts/check-docs-consistency.sh
  • scripts/check-file-size.sh

konard added 2 commits April 18, 2026 22:11
Adding .gitkeep for PR creation (default mode).
This file will be removed when the task is complete.

Issue: netkeep80#281
@konard konard changed the title [WIP] [docs-comments-cleanup] Схлопнуть и канонизировать политику документации и комментариев PMM [docs-comments-cleanup] Canonicalize PMM text policy Apr 18, 2026
@konard konard marked this pull request as ready for review April 18, 2026 22:15
@konard
Copy link
Copy Markdown
Contributor Author

konard commented Apr 18, 2026

Solution summary

Implemented and pushed the fix for issue 281.

PR: #282

Changed:

  • docs/comment_policy.md: made it the canonical policy for comment discipline, docs placement, surface reduction, and text-change review semantics.
  • CONTRIBUTING.md: removed duplicated comment-policy details and replaced them with canonical links.
  • docs/index.md: updated the comment policy description to match its canonical role.

Surface result:

  • New markdown files: 0
  • Changed docs: 3 allowed files
  • Net markdown delta: 55 insertions / 56 deletions, net -1 line
  • Code surface: untouched
  • Generated surface: untouched
  • Removed the prepared-branch placeholder .gitkeep, so it no longer appears in the PR diff.

Verification:

  • scripts/check-docs-consistency.sh passed
  • scripts/check-file-size.sh passed
  • GitHub Actions on the fork shows Docs Consistency passed for commit fdaa410

PR 282 is updated, pushed, and marked ready for review. Next useful follow-ups:

  1. Review the PR text for preferred Russian/English wording.
  2. Wait for any upstream-required checks beyond the fork’s Docs Consistency run.

This summary was automatically extracted from the AI working session output.

@konard
Copy link
Copy Markdown
Contributor Author

konard commented Apr 18, 2026

🤖 Solution Draft Log

This log file contains the complete execution trace of the AI solution draft process.

💰 Cost estimation:

  • Model: gpt-5.4
  • Provider: OpenAI
  • Public pricing estimate: unknown
  • Token usage: 43,883 input, 7,451 output, 915,072 cache read

📊 Context and tokens usage:

Total: (43.9K + 915.1K cached) input tokens, 7.5K output tokens

🤖 Models used:

  • Tool: OpenAI Codex
  • Requested: gpt-5.4
  • Model: GPT-5.4 (gpt-5.4)

📎 Log file uploaded as Gist (12170KB)


Now working session is ended, feel free to review and add any feedback on the solution draft.

@konard
Copy link
Copy Markdown
Contributor Author

konard commented Apr 18, 2026

✅ Ready to merge

This pull request is now ready to be merged:

  • All CI checks have passed
  • No merge conflicts
  • No pending changes

Monitored by hive-mind with --auto-restart-until-mergeable flag

@netkeep80 netkeep80 merged commit 1b06aa3 into netkeep80:main Apr 18, 2026
4 checks passed
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.

[docs-comments-cleanup] Схлопнуть и канонизировать политику документации и комментариев PMM

2 participants