Skip to content

chore: remove docs notes and update snapshots#30

Merged
gabewillen merged 4 commits into
mainfrom
chore/remove-docs-snapshots-2026-03
Mar 3, 2026
Merged

chore: remove docs notes and update snapshots#30
gabewillen merged 4 commits into
mainfrom
chore/remove-docs-snapshots-2026-03

Conversation

@gabewillen

Copy link
Copy Markdown
Contributor

Summary

  • Remove obsolete docs: docs/notes.md, docs/gaps.md, docs/compliance.report.md
  • Rerun and update snapshots: snapshots/bench/benchmarks.txt, snapshots/lint/clang_format.txt, snapshots/quality_gates/timing.txt
  • Regenerated docs with tools/docsgen

Validation

  • scripts/lint_snapshot.sh --update
  • scripts/bench.sh --snapshot --update
  • scripts/generate_docs.sh
  • scripts/quality_gates.sh (run with EMEL_QUALITY_GATES_INNER=1)

This updates snapshots to reflect current baseline after the docs removals.,

Copilot AI review requested due to automatic review settings March 3, 2026 03:31

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 652934bf7d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/gaps.md

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Removes obsolete documentation artifacts and refreshes repository snapshot baselines (bench, lint, quality gates timing) to reflect the current state after doc cleanup and regeneration.

Changes:

  • Delete obsolete docs notes/reports under docs/.
  • Update benchmark snapshot output to the current bench_runner snapshot format/content.
  • Update lint and quality-gates timing snapshot baselines.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
snapshots/quality_gates/timing.txt Updates recorded step timings and includes generate_docs in the timing snapshot.
snapshots/lint/clang_format.txt Refreshes clang-format regression baseline list after re-running snapshot tooling.
snapshots/bench/benchmarks.txt Refreshes benchmark snapshot baseline; now includes iter=/runs= fields and updated entries.
docs/notes.md Removes obsolete notes document.
docs/gaps.md Removes parity gap/audit status document.
docs/compliance.report.md Removes generated compliance report document.
Comments suppressed due to low confidence (2)

snapshots/bench/benchmarks.txt:7

  • The benchmark snapshot change is larger than a "docs removals" baseline update: the format now includes iter=/runs= fields and some previously-present benchmark groups (e.g., kernel/x86_64/*) are no longer listed. Please confirm this is expected for the environments where snapshots are validated, and consider updating the PR description to call out the snapshot format/content change explicitly.
# ref=ecbcb7ea9d3303097519723b264a8b5f1e977028
# toolchain=/opt/homebrew/bin/zig
batch/planner_equal ns_per_op=1882.532 iter=100000 runs=5
batch/planner_seq ns_per_op=1793.446 iter=100000 runs=5
batch/planner_simple ns_per_op=1226.921 iter=100000 runs=5
gbnf/rule_parser_basic ns_per_op=255.746 iter=100000 runs=5
gbnf/rule_parser_complex ns_per_op=1825.217 iter=100000 runs=5

snapshots/quality_gates/timing.txt:7

  • Since this PR removes docs files (e.g., docs/gaps.md), please also update any docs entry points that link to them (notably README.md has a "Parity Audit" link to docs/gaps.md). Otherwise generate_docs will succeed but the repo will have a broken documentation link.
generate_docs 38

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@gabewillen gabewillen merged commit a0612fb into main Mar 3, 2026
@gabewillen gabewillen deleted the chore/remove-docs-snapshots-2026-03 branch March 3, 2026 04:18
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.

2 participants