Skip to content

Docs cleanup: remove textual include shard references#389

Merged
netkeep80 merged 3 commits into
netkeep80:mainfrom
konard:issue-388-c8c708a4aad5
Jun 2, 2026
Merged

Docs cleanup: remove textual include shard references#389
netkeep80 merged 3 commits into
netkeep80:mainfrom
konard:issue-388-c8c708a4aad5

Conversation

@konard

@konard konard commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Summary

Remove documentation references to textual include shards while preserving the same semantic invariant checkpoints.

Linked issue

Fixes #388

Change class

docs-comments-cleanup

Change Contract

change_type: docs-comments-cleanup
scope:
  - docs/compatibility_audit.md
  - docs/core_invariants.md
  - docs/diagnostics_taxonomy.md
  - docs/include_source_review.md
  - docs/internal_structure.md
  - docs/mutation_ordering.md
  - docs/verify_repair_contract.md
budgets:
  max_new_files: 0
  max_new_docs: 0
  max_net_added_lines: 0
must_touch:
  - docs/core_invariants.md
  - docs/mutation_ordering.md
must_not_touch:
  - include/**
  - tests/**
  - single_include/**
  - repo-policy.json
  - .github/**
  - CHANGELOG.md
  - changelog.d/**
expected_effects:
  - Documentation no longer cites current textual include shard filenames or line checkpoints.
  - Existing invariant and repair checkpoints remain referenced by function or behavior.

Target surface

  • docs/compatibility_audit.md
  • docs/core_invariants.md
  • docs/diagnostics_taxonomy.md
  • docs/include_source_review.md
  • docs/internal_structure.md
  • docs/mutation_ordering.md
  • docs/verify_repair_contract.md

Non-goals

  • No code changes.
  • No tests changes.
  • No generated changes.
  • No governance changes.
  • No new documents.
  • No .inc shard removal in this PR.

Surface delta

  • New files: 0
  • Deleted files: 0
  • Net lines: -6
  • Public API change: no
  • Generated surface touched: no
  • Docs touched: yes
  • Governance touched: no

Complexity delta

Removes documentation coupling to temporary textual include shards and stale line-number checkpoints, so later shard compaction can be attempted without repeating these docs edits.

Preserved invariants

  • Bootstrap invariant validation for required system domains, system flags, registry magic/version, and symbol dictionary roots.
  • Forest registry verify/repair behavior through verify_forest_registry_unlocked() and validate_or_bootstrap_forest_registry_unlocked().
  • Verify/read-only and load/repair diagnostic behavior through verify_image_unlocked() and load(VerifyResult&).
  • Mutation ordering for registry bootstrap, domain registration/update, symbol interning, and header trust anchors.
  • Compatibility audit checkpoint for the legacy root migration cleanup.

Verification

  • rg -n "forest_domain_mixin|verify_repair_mixin|layout_mixin" docs (no matches)
  • bash scripts/check-docs-consistency.sh
  • bash scripts/check-repo-guard-rollout.sh
  • ./scripts/test.sh (99/99 tests passed)

Reviewer checklist

  • One PR = one reason for change
  • Docs-only change
  • No include/** changes
  • No single_include/** changes
  • No governance changes
  • No new documents
  • Direct .inc references removed where feasible
  • Semantic checkpoints preserved
  • Net documentation surface is non-positive or justified

konard added 2 commits June 2, 2026 12:42
Adding .gitkeep for PR creation (default mode).
This file will be removed when the task is complete.

Issue: netkeep80#388
@konard konard changed the title [WIP] # Docs cleanup: remove direct documentation coupling to textual include shards Docs cleanup: remove textual include shard references Jun 2, 2026
@konard
konard marked this pull request as ready for review June 2, 2026 12:52
@konard

konard commented Jun 2, 2026

Copy link
Copy Markdown
Contributor Author

Working session summary

Implemented and pushed the docs-only cleanup.

PR: #389

Changed the seven target docs files to replace direct forest_domain_mixin.inc, verify_repair_mixin.inc, and layout_mixin.inc citations with function/behavior-level checkpoints. Final PR diff is net negative: 45 insertions, 51 deletions, no new/deleted files, no code/tests/generated/governance changes.

Verification passed:

  • rg -n "forest_domain_mixin|verify_repair_mixin|layout_mixin" docs returned no matches
  • bash scripts/check-docs-consistency.sh
  • bash scripts/check-repo-guard-rollout.sh
  • ./scripts/test.sh passed 99/99
  • Upstream PR checks pass: docs consistency, version consistency, repo-guard

PR 389 is marked ready for review, mergeable, and the working tree is clean.


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

@konard

konard commented Jun 2, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Solution Draft Log

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

💰 Cost estimation:

  • Model: GPT-5.5
  • Provider: OpenAI
  • Public pricing estimate: $6.420422

📊 Context and tokens usage:

  • 118.1K / 1.1M (11%) input tokens, 23.8K / 128K (19%) output tokens

Total: (118.1K + 4.2M cached) input tokens, 23.8K output tokens, $6.420422 cost

🤖 Models used:

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

📎 Log file uploaded as Repository (30287KB)


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

@konard

konard commented Jun 2, 2026

Copy link
Copy Markdown
Contributor Author

✅ 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 2d20dde into netkeep80:main Jun 2, 2026
3 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 cleanup: remove direct documentation coupling to textual include shards

2 participants